diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index c82a4fa5..48f63628 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: fca0ac3a-5f4e-452c-bbc7-2311afa8da40 management: - docChecksum: 662624453f543efd670cc931652a4b56 + docChecksum: 88395713ea68331aa4251d8b7fed439a docVersion: 10.14.1 - speakeasyVersion: 1.528.1 - generationVersion: 2.565.1 - releaseVersion: 0.10.0 - configChecksum: 54ed6ff09e28eca3f654b509400948e8 + speakeasyVersion: 1.531.0 + generationVersion: 2.568.2 + releaseVersion: 0.10.1 + configChecksum: 2120f83ccf84b5ee8a3b0019dceacd46 repoURL: https://github.com/apideck-libraries/sdk-python.git installationURL: https://github.com/apideck-libraries/sdk-python.git published: true @@ -15,7 +15,7 @@ features: acceptHeaders: 3.0.0 additionalDependencies: 1.0.0 constsAndDefaults: 1.0.5 - core: 5.12.5 + core: 5.12.6 deepObjectParams: 0.1.0 defaultEnabledRetries: 0.2.0 deprecations: 3.0.2 @@ -1873,28 +1873,28 @@ generatedFiles: - src/apideck_unify/models/accounting_trackingcategoriesdeleteop.py - src/apideck_unify/models/accounting_trackingcategoriesoneop.py - src/apideck_unify/models/accounting_trackingcategoriesupdateop.py - - src/apideck_unify/models/accountingdepartment.py + - src/apideck_unify/models/accountingdepartment_input.py - src/apideck_unify/models/accountingdepartmentsfilter.py - src/apideck_unify/models/accountinglocation.py - src/apideck_unify/models/accountinglocationsfilter.py - src/apideck_unify/models/activitiesfilter.py - src/apideck_unify/models/activitiessort.py - - src/apideck_unify/models/activity.py - - src/apideck_unify/models/activityattendee.py + - src/apideck_unify/models/activity_input.py + - src/apideck_unify/models/activityattendee_input.py - src/apideck_unify/models/address.py - src/apideck_unify/models/agedcreditors.py - src/apideck_unify/models/ageddebtors.py - src/apideck_unify/models/agedreportfilter.py - - src/apideck_unify/models/allocation.py + - src/apideck_unify/models/allocation_input.py - src/apideck_unify/models/api.py - src/apideck_unify/models/apierror.py - src/apideck_unify/models/apiresource.py - src/apideck_unify/models/apiresourcecoverage.py - src/apideck_unify/models/apisfilter.py - src/apideck_unify/models/apistatus.py - - src/apideck_unify/models/applicant.py + - src/apideck_unify/models/applicant_input.py - src/apideck_unify/models/applicantsfilter.py - - src/apideck_unify/models/application.py + - src/apideck_unify/models/application_input.py - src/apideck_unify/models/assignee.py - src/apideck_unify/models/assignee_input.py - src/apideck_unify/models/ats_applicantsaddop.py @@ -1920,7 +1920,7 @@ generatedFiles: - src/apideck_unify/models/balancesheetfilter.py - src/apideck_unify/models/bankaccount.py - src/apideck_unify/models/benefit.py - - src/apideck_unify/models/bill.py + - src/apideck_unify/models/bill_input.py - src/apideck_unify/models/billlineitem.py - src/apideck_unify/models/billpayment.py - src/apideck_unify/models/billsfilter.py @@ -1938,7 +1938,7 @@ generatedFiles: - src/apideck_unify/models/company.py - src/apideck_unify/models/companyinfo.py - src/apideck_unify/models/compensation.py - - src/apideck_unify/models/connection.py + - src/apideck_unify/models/connection_input.py - src/apideck_unify/models/connectionimportdata.py - src/apideck_unify/models/connectionstate.py - src/apideck_unify/models/connector.py @@ -1961,7 +1961,7 @@ generatedFiles: - src/apideck_unify/models/consumerconnection.py - src/apideck_unify/models/consumermetadata.py - src/apideck_unify/models/consumerrequestcountsindaterangeresponse.py - - src/apideck_unify/models/contact.py + - src/apideck_unify/models/contact_input.py - src/apideck_unify/models/contactsfilter.py - src/apideck_unify/models/contactssort.py - src/apideck_unify/models/copyfolderrequest.py @@ -2014,7 +2014,7 @@ generatedFiles: - src/apideck_unify/models/createuserresponse.py - src/apideck_unify/models/createwebhookrequest.py - src/apideck_unify/models/createwebhookresponse.py - - src/apideck_unify/models/creditnote.py + - src/apideck_unify/models/creditnote_input.py - src/apideck_unify/models/creditnotesfilter.py - src/apideck_unify/models/creditnotessort.py - src/apideck_unify/models/crm_activitiesaddop.py @@ -2138,9 +2138,9 @@ generatedFiles: - src/apideck_unify/models/ecommerceproduct.py - src/apideck_unify/models/ecommercestore.py - src/apideck_unify/models/email.py - - src/apideck_unify/models/employee.py + - src/apideck_unify/models/employee_input.py - src/apideck_unify/models/employeecompensation.py - - src/apideck_unify/models/employeejob.py + - src/apideck_unify/models/employeejob_input.py - src/apideck_unify/models/employeepayroll.py - src/apideck_unify/models/employeeschedules.py - src/apideck_unify/models/employeesfilter.py @@ -2378,7 +2378,7 @@ generatedFiles: - src/apideck_unify/models/lead_input.py - src/apideck_unify/models/leadsfilter.py - src/apideck_unify/models/leadssort.py - - src/apideck_unify/models/ledgeraccount.py + - src/apideck_unify/models/ledgeraccount_input.py - src/apideck_unify/models/ledgeraccountsfilter.py - src/apideck_unify/models/ledgeraccountssort.py - src/apideck_unify/models/linkedconnectorresource.py @@ -2399,7 +2399,7 @@ generatedFiles: - src/apideck_unify/models/links.py - src/apideck_unify/models/log.py - src/apideck_unify/models/logsfilter.py - - src/apideck_unify/models/message.py + - src/apideck_unify/models/message_input.py - src/apideck_unify/models/meta.py - src/apideck_unify/models/note.py - src/apideck_unify/models/note_input.py @@ -2437,7 +2437,7 @@ generatedFiles: - src/apideck_unify/models/profitandlossfilter.py - src/apideck_unify/models/profitandlossindicator.py - src/apideck_unify/models/profitandlosstype.py - - src/apideck_unify/models/purchaseorder.py + - src/apideck_unify/models/purchaseorder_input.py - src/apideck_unify/models/purchaseordersfilter.py - src/apideck_unify/models/purchaseorderssort.py - src/apideck_unify/models/requestcountallocation.py @@ -2457,7 +2457,7 @@ generatedFiles: - src/apideck_unify/models/sociallink.py - src/apideck_unify/models/sortdirection.py - src/apideck_unify/models/status.py - - src/apideck_unify/models/subsidiary.py + - src/apideck_unify/models/subsidiary_input.py - src/apideck_unify/models/subsidiaryreference.py - src/apideck_unify/models/subsidiaryreference_input.py - src/apideck_unify/models/supplier.py @@ -2465,14 +2465,14 @@ generatedFiles: - src/apideck_unify/models/supplierssort.py - src/apideck_unify/models/supportedproperty.py - src/apideck_unify/models/tax.py - - src/apideck_unify/models/taxrate.py + - src/apideck_unify/models/taxrate_input.py - src/apideck_unify/models/taxratesfilter.py - src/apideck_unify/models/team.py - - src/apideck_unify/models/ticket.py + - src/apideck_unify/models/ticket_input.py - src/apideck_unify/models/ticketssort.py - - src/apideck_unify/models/timeoffrequest.py + - src/apideck_unify/models/timeoffrequest_input.py - src/apideck_unify/models/timeoffrequestsfilter.py - - src/apideck_unify/models/trackingcategory.py + - src/apideck_unify/models/trackingcategory_input.py - src/apideck_unify/models/trackingitem.py - src/apideck_unify/models/unauthorizedresponse.py - src/apideck_unify/models/unexpectederrorresponse.py @@ -2703,7 +2703,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"id": "1234", "name": "GST on Purchases", "code": "ABN", "description": "Reduced rate GST Purchases", "effective_tax_rate": 10, "total_tax_rate": 10, "tax_payable_account_id": "123456", "tax_remitted_account_id": "123456", "components": [{"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}], "type": "NONE", "report_tax_type": "NONE", "original_tax_rate_id": "12345", "status": "active", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}]} + application/json: {"id": "1234", "name": "GST on Purchases", "code": "ABN", "description": "Reduced rate GST Purchases", "effective_tax_rate": 10, "total_tax_rate": 10, "tax_payable_account_id": "123456", "tax_remitted_account_id": "123456", "components": [{"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}], "type": "NONE", "report_tax_type": "NONE", "original_tax_rate_id": "12345", "status": "active", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "tax-rates", "operation": "update", "data": {"id": "12345"}} @@ -2761,7 +2761,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}, {"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}, {"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "source_document_url": "https://www.invoicesolution.com/bill/123456", "tracking_categories": [{"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}, {"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "source_document_url": "https://www.invoicesolution.com/bill/123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}, {"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "source_document_url": "https://www.invoicesolution.com/bill/123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -2784,7 +2784,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"bill_number": "10001", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} + application/json: {"bill_number": "10001", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "source_document_url": "https://www.invoicesolution.com/bill/123456", "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "add", "data": {"id": "12345"}} @@ -2814,7 +2814,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "bill_number": "10001", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "source_document_url": "https://www.invoicesolution.com/bill/123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -2839,7 +2839,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"bill_number": "10001", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} + application/json: {"bill_number": "10001", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "source_document_url": "https://www.invoicesolution.com/bill/123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "update", "data": {"id": "12345"}} @@ -2897,7 +2897,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -2920,7 +2920,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "add", "data": {"id": "12345", "downstream_id": "12345"}} @@ -2950,7 +2950,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -2975,7 +2975,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "update", "data": {"id": "12345", "downstream_id": "12345"}} @@ -3160,16 +3160,16 @@ examples: raw: false limit: 20 filter: {"name": "Widgets Large", "type": "service"} + sort: {"by": "updated_at", "direction": "desc"} pass_through: {"search": "San Francisco"} fields: "id,updated_at" - sort: {"by": "updated_at", "direction": "desc"} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoice-items", "operation": "all", "data": [{"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "active": true, "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoice-items", "operation": "all", "data": [{"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_schedule_id": "123456", "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_schedule_id": "123456", "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "active": true, "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_schedule_id": "123456", "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3192,7 +3192,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_schedule_id": "123456", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoice-items", "operation": "add", "data": {"id": "12345"}} @@ -3223,7 +3223,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoice-items", "operation": "one", "data": {"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoice-items", "operation": "one", "data": {"id": "123456", "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_schedule_id": "123456", "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3248,7 +3248,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", "sold": true, "purchased": true, "tracked": true, "taxable": true, "inventory_date": "2020-10-30", "type": "inventory", "sales_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "purchase_details": {"unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": true, "tax_rate": {"id": "123456", "rate": 10}}, "quantity": 1, "unit_price": 27500.5, "asset_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "income_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "expense_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "active": true, "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_schedule_id": "123456", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoice-items", "operation": "update", "data": {"id": "12345"}} @@ -3306,7 +3306,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "all", "data": [{"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "all", "data": [{"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3329,7 +3329,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "allocations": [{"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "allocations": [{"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "add", "data": {"id": "12345"}} @@ -3359,7 +3359,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "one", "data": {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "one", "data": {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3384,7 +3384,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "allocations": [{"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "allocations": [{"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "update", "data": {"id": "12345"}} @@ -3465,7 +3465,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "customers", "operation": "add", "data": {"id": "12345"}} @@ -3520,7 +3520,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "customers", "operation": "update", "data": {"id": "12345"}} @@ -3601,7 +3601,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "add", "data": {"id": "12345"}} @@ -3656,7 +3656,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "suppliers", "operation": "update", "data": {"id": "12345"}} @@ -3899,7 +3899,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "ProfitAndLosses", "operation": "one", "data": {"id": "12345", "report_name": "ProfitAndLoss", "start_date": "2017-01-01", "end_date": "2017-01-01", "currency": "USD", "income": {"total": 200000, "records": [{"id": "123", "name": "Income 1", "amount": 10000}, {"id": "456", "name": "Income 2", "amount": 20000}]}, "expenses": {"total": 200000, "records": [{"id": "123", "name": "Expense 1", "amount": 10000}, {"id": "456", "name": "Expense 2", "amount": 20000}]}, "gross_profit": {"total": 200000}, "net_operating_income": {"total": 200000}, "net_income": {"total": 200000}}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "ProfitAndLosses", "operation": "one", "data": {"id": "12345", "report_name": "ProfitAndLoss", "start_date": "2017-01-01", "end_date": "2017-01-31", "currency": "USD", "income": {"id": "123", "code": "123", "title": "Operating Income", "type": "Section", "total": 60000, "records": [{"id": "137", "title": "Sales of products", "code": "137", "type": "Section", "total": 20000, "records": [{"id": "13701", "title": "Sales of products", "code": "13701", "type": "Record", "total": 20000}]}, {"id": "138", "title": "Sales of services", "code": "138", "type": "Section", "total": 40000, "records": [{"id": "789", "code": "789", "title": "Sales of External Services", "type": "Record", "total": 10000}, {"id": "101", "code": "101", "title": "Sales of Internal Services", "type": "Record", "total": 30000}]}]}, "cost_of_goods_sold": {"id": "123", "code": "123", "title": "Cost of Goods Sold", "type": "Section", "total": 12000, "records": [{"id": "123", "code": "123", "title": "COGS Sales", "type": "Record", "total": 12000}]}, "expenses": {"id": "123", "code": "123", "title": "Operating Expenses", "type": "Section", "total": 14000, "records": [{"id": "137", "title": "Maintenance", "code": "137", "type": "Record", "total": 1000}, {"id": "138", "title": "Rent", "code": "138", "type": "Record", "total": 10000}, {"id": "789", "code": "789", "title": "Utilities", "type": "Section", "total": 3000, "records": [{"id": "101", "code": "101", "title": "Electricity", "type": "Record", "total": 2000}, {"id": "102", "code": "102", "title": "Telephone", "type": "Record", "total": 1000}]}]}, "other_income": {"id": "123", "code": "123", "title": "Other Income", "type": "Section", "total": 3000, "records": [{"id": "123", "code": "123", "title": "Interest Income", "type": "Record", "total": 2000}, {"id": "123", "code": "123", "title": "Foreign Exchange Gain", "type": "Record", "total": 1000}]}, "other_expenses": {"id": "123", "code": "123", "title": "Other Expenses", "type": "Section", "total": 1000, "records": [{"id": "123", "code": "123", "title": "Unrealized Gain/Loss", "type": "Record", "total": 1000}]}, "uncategorized_accounts": {"id": "123", "code": "123", "title": "Uncategorized Accounts", "type": "Section", "total": 0, "records": [{"id": "123", "code": "123", "title": "Elimination Adjustments", "type": "Record", "total": 0}]}, "gross_profit": {"total": 10000}, "net_operating_income": {"total": 10000}, "net_income": {"total": 10000}, "customer": "123"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3951,7 +3951,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": "USD", "company_id": "12345", "line_items": [{"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}], "memo": "Thank you for your business and have a great day!", "posted_at": "2020-09-30T07:43:32.000Z", "journal_symbol": "IND", "tax_type": "sales", "tax_code": "1234", "number": "OIT00546", "tracking_categories": [{"id": "123456", "name": "New York"}], "accounting_period": "01-24", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": "USD", "company_id": "12345", "line_items": [{"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "department_id": "12345", "location_id": "12345", "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "department_id": "12345", "location_id": "12345", "line_number": 1}], "memo": "Thank you for your business and have a great day!", "posted_at": "2020-09-30T07:43:32.000Z", "journal_symbol": "IND", "tax_type": "sales", "tax_code": "1234", "number": "OIT00546", "tracking_categories": [{"id": "123456", "name": "New York"}], "accounting_period": "01-24", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "journal-entries", "operation": "add", "data": {"id": "12345"}} @@ -4006,7 +4006,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": "USD", "company_id": "12345", "line_items": [{"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}], "memo": "Thank you for your business and have a great day!", "posted_at": "2020-09-30T07:43:32.000Z", "journal_symbol": "IND", "tax_type": "sales", "tax_code": "1234", "number": "OIT00546", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "accounting_period": "01-24", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": "USD", "company_id": "12345", "line_items": [{"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "department_id": "12345", "location_id": "12345", "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "department_id": "12345", "location_id": "12345", "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "department_id": "12345", "location_id": "12345", "line_number": 1}], "memo": "Thank you for your business and have a great day!", "posted_at": "2020-09-30T07:43:32.000Z", "journal_symbol": "IND", "tax_type": "sales", "tax_code": "1234", "number": "OIT00546", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "accounting_period": "01-24", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "journal-entries", "operation": "update", "data": {"id": "12345"}} @@ -4063,19 +4063,19 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.purchaseOrdersAdd: "": parameters: @@ -4086,7 +4086,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "add", "data": {"id": "12345"}} @@ -4115,7 +4115,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -4123,11 +4123,11 @@ examples: "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.purchaseOrdersUpdate: "": parameters: @@ -4140,7 +4140,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "update", "data": {"id": "12345"}} @@ -4151,11 +4151,11 @@ examples: "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.purchaseOrdersDelete: "": parameters: @@ -4612,6 +4612,64 @@ examples: application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + accounting.attachmentsUpload: + "": + parameters: + path: + reference_type: "invoice" + reference_id: "123456" + query: + raw: false + header: + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + requestBody: + '*/*': "x-file: example.file" + responses: + "201": + application/json: {"status_code": 200, "status": "OK", "service": "google-drive", "resource": "files", "operation": "add", "data": {"id": "12345"}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + basic: + parameters: + path: + reference_type: "invoice" + reference_id: "12345" + query: + raw: false + header: + x-apideck-metadata: "{\"name\":\"document.pdf\",\"description\":\"Invoice attachment\"}" + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + requestBody: + '*/*': "x-file: example.file" + responses: + "201": + application/json: {"status_code": 200, "status": "OK", "service": "google-drive", "resource": "files", "operation": "add", "data": {"id": "12345"}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.attachmentsOne: "": parameters: @@ -4979,7 +5037,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "all", "data": [{"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "all", "data": [{"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5002,7 +5060,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "add", "data": {"id": "12345"}} @@ -5031,7 +5089,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "one", "data": {"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "one", "data": {"id": "12345", "number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "total_amount": 275, "line_items": [{"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"id": "12345", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5056,7 +5114,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "subsidiary_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "update", "data": {"id": "12345"}} @@ -5098,6 +5156,33 @@ examples: application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + accounting.agedCreditorsOne: + "": + parameters: + query: + raw: false + filter: {"customer_id": "123abc", "supplier_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30} + pass_through: {"search": "San Francisco"} + fields: "id,updated_at" + header: + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + responses: + "200": + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "AgedCreditors", "operation": "one", "data": {"report_generated_at": "2024-11-14T12:00:00.000Z", "report_as_of_date": "2024-11-13", "period_count": 4, "period_length": 30, "outstanding_balances": [{"supplier_id": "123", "supplier_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}, {"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}]}, {"supplier_id": "123", "supplier_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}]}, {"supplier_id": "123", "supplier_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}]}]}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.agedDebtorsOne: "": parameters: @@ -5194,7 +5279,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5462,7 +5547,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5621,7 +5706,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "add", "data": {"id": "12345"}} @@ -5677,7 +5762,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "update", "data": {"id": "12345"}} @@ -5735,7 +5820,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "opportunities", "operation": "all", "data": [{"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "opportunities", "operation": "all", "data": [{"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5894,7 +5979,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "add", "data": {"id": "12345"}} @@ -5949,7 +6034,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "update", "data": {"id": "12345"}} @@ -6018,6 +6103,113 @@ examples: application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + crm.pipelinesAdd: + "": + parameters: + query: + raw: false + header: + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + requestBody: + application/json: {"id": "default", "name": "Sales Pipeline", "currency": "USD", "archived": false, "active": false, "display_order": 1, "win_probability_enabled": true, "stages": [{"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + responses: + "201": + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "pipelines", "operation": "add", "data": {"id": "12345"}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + crm.pipelinesOne: + "": + parameters: + path: + id: "" + query: + raw: false + fields: "id,updated_at" + header: + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + responses: + "200": + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "pipelines", "operation": "one", "data": {"id": "default", "name": "Sales Pipeline", "currency": "USD", "archived": false, "active": false, "display_order": 1, "win_probability_enabled": true, "stages": [{"id": "contractsent", "name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"id": "contractsent", "name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"id": "contractsent", "name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + crm.pipelinesUpdate: + "": + parameters: + path: + id: "" + query: + raw: false + header: + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + requestBody: + application/json: {"id": "default", "name": "Sales Pipeline", "currency": "USD", "archived": false, "active": false, "display_order": 1, "win_probability_enabled": true, "stages": [{"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + responses: + "200": + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "pipelines", "operation": "update", "data": {"id": "12345"}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + crm.pipelinesDelete: + "": + parameters: + path: + id: "" + query: + raw: false + header: + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + responses: + "200": + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "delete", "data": {"id": "12345"}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.notesAll: "": parameters: @@ -6302,7 +6494,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "activities", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "activities", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -6648,8 +6840,8 @@ examples: pass_through: {"search": "San Francisco"} fields: "id,updated_at" limit: 20 - filter: {"drive_id": "1234", "folder_id": "root", "shared": true} raw: false + filter: {"drive_id": "1234", "folder_id": "root", "shared": true} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7129,6 +7321,36 @@ examples: application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + fileStorage.uploadSessionsUpload: + "": + parameters: + path: + id: "" + query: + part_number: 0 + raw: false + header: + x-apideck-consumer-id: "test-consumer" + x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" + x-apideck-service-id: "salesforce" + digest: "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=" + requestBody: + '*/*': "" + responses: + "200": + application/json: {"status_code": 200, "status": "OK", "service": "dropbox", "resource": "UploadSessions", "operation": "one", "data": {"id": "12345"}} + "400": + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + "401": + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "402": + application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} + "404": + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + "422": + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + default: + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.uploadSessionsDelete: "": parameters: @@ -7467,7 +7689,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "all", "data": [{"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -7522,7 +7744,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "one", "data": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -7547,7 +7769,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "update", "data": {"id": "12345"}} @@ -7983,7 +8205,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "all", "data": {"employee": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, "schedules": [{"id": "12345", "start_date": "2022-04-08", "end_date": "2022-04-21", "work_pattern": {"odd_weeks": {"hours_monday": 8, "hours_tuesday": 8, "hours_wednesday": 4, "hours_thursday": 7.5, "hours_friday": 4, "hours_saturday": 0, "hours_sunday": 0}, "even_weeks": {"hours_monday": 8, "hours_tuesday": 8, "hours_wednesday": 4, "hours_thursday": 7.5, "hours_friday": 4, "hours_saturday": 0, "hours_sunday": 0}}}]}} + application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "all", "data": {"employee": {"id": "12345", "downstream_id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, "schedules": [{"id": "12345", "start_date": "2022-04-08", "end_date": "2022-04-21", "work_pattern": {"odd_weeks": {"hours_monday": 8, "hours_tuesday": 8, "hours_wednesday": 4, "hours_thursday": 7.5, "hours_friday": 4, "hours_saturday": 0, "hours_sunday": 0}, "even_weeks": {"hours_monday": 8, "hours_tuesday": 8, "hours_wednesday": 4, "hours_thursday": 7.5, "hours_friday": 4, "hours_saturday": 0, "hours_sunday": 0}}}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -8860,7 +9082,7 @@ examples: application/json: {"consumer_id": "test_consumer_id", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}} responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"consumer_id": "test_consumer_id", "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}, "connections": [{"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}], "services": ["salesforce", "stripe"], "aggregated_request_count": 101, "request_counts": {"unify": 100, "proxy": 10, "vault": 21}, "created": "2021-05-07T12:55:42.242Z", "modified": "2021-05-07T12:55:42.242Z", "request_count_updated": "2021-05-07T12:55:42.242Z"}} + application/json: {"status_code": 200, "status": "OK", "data": {"consumer_id": "test_consumer_id", "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}, "connections": [{"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}], "services": ["salesforce", "stripe"], "aggregated_request_count": 101, "request_counts": {"unify": 100, "proxy": 10, "vault": 21}, "created": "2021-05-07T12:55:42.242Z", "modified": "2021-05-07T12:55:42.242Z", "request_count_updated": "2021-05-07T12:55:42.242Z"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -8904,7 +9126,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"consumer_id": "test_consumer_id", "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}, "connections": [{"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}], "services": ["salesforce", "stripe"], "aggregated_request_count": 101, "request_counts": {"unify": 100, "proxy": 10, "vault": 21}, "created": "2021-05-07T12:55:42.242Z", "modified": "2021-05-07T12:55:42.242Z", "request_count_updated": "2021-05-07T12:55:42.242Z"}} + application/json: {"status_code": 200, "status": "OK", "data": {"consumer_id": "test_consumer_id", "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}, "connections": [{"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}], "services": ["salesforce", "stripe"], "aggregated_request_count": 101, "request_counts": {"unify": 100, "proxy": 10, "vault": 21}, "created": "2021-05-07T12:55:42.242Z", "modified": "2021-05-07T12:55:42.242Z", "request_count_updated": "2021-05-07T12:55:42.242Z"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -8928,7 +9150,7 @@ examples: application/json: {"metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}} responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"consumer_id": "test_consumer_id", "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}, "connections": [{"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}], "services": ["salesforce", "stripe"], "aggregated_request_count": 101, "request_counts": {"unify": 100, "proxy": 10, "vault": 21}, "created": "2021-05-07T12:55:42.242Z", "modified": "2021-05-07T12:55:42.242Z", "request_count_updated": "2021-05-07T12:55:42.242Z"}} + application/json: {"status_code": 200, "status": "OK", "data": {"consumer_id": "test_consumer_id", "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}, "connections": [{"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}, {"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}], "services": ["salesforce", "stripe"], "aggregated_request_count": 101, "request_counts": {"unify": 100, "proxy": 10, "vault": 21}, "created": "2021-05-07T12:55:42.242Z", "modified": "2021-05-07T12:55:42.242Z", "request_count_updated": "2021-05-07T12:55:42.242Z"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -8999,17 +9221,17 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": [{"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}], "value": 10}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}, {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": "GC5000 series"}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": [10.5, 10, 10.5]}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}], "value": [10]}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": 10}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}, {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": ["GC6000 series", "GC6000 series"]}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}]} + application/json: {"status_code": 200, "status": "OK", "data": [{"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}, {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "value": [10.5]}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}, {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": ["GC6000 series", 10, "GC6000 series"]}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}]} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} vault.connectionsOne: @@ -9023,11 +9245,11 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} + application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -9046,10 +9268,10 @@ examples: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" requestBody: - application/json: {"enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "configuration": [{"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}], "value": 10.5}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "value": true}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": 10}, {"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "value": "GC5000 series"}, {"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10.5}]}], "custom_mappings": [{"value": "$.root.training.first_aid"}]} + application/json: {"enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "configuration": [{"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": 10.5}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}], "value": true}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": [10.5, 10, "GC6000 series"]}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": true}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}]}], "custom_mappings": [{"value": "$.root.training.first_aid"}, {"value": "$.root.training.first_aid"}]} responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} + application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": 10.5}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -9057,11 +9279,11 @@ examples: "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} vault.connectionsDelete: "": parameters: @@ -9097,7 +9319,7 @@ examples: application/json: {"credentials": {"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ", "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}} responses: "200": - application/json: {"status_code": 201, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}], "value": 10}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": [10]}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": ["GC6000 series", 10.5, 10]}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} + application/json: {"status_code": 201, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": "GC5000 series"}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": "GC5000 series"}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}], "value": [10]}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": ["GC6000 series", 10.5, 10]}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -9121,7 +9343,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": []}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} + application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "value": []}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -9196,15 +9418,15 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": "GC5000 series"}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": []}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}], "value": 10}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": "GC5000 series"}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} + application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": []}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: @@ -9220,10 +9442,10 @@ examples: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" requestBody: - application/json: {"enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "configuration": [{"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}], "value": 10.5}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "value": true}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}], "value": 10}, {"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}], "value": 10.5}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 12.5, "option_type": "simple"}], "value": "GC5000 series"}, {"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10.5}]}], "custom_mappings": [{"value": "$.root.training.first_aid"}]} + application/json: {"enabled": true, "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "configuration": [{"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": 10.5}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}], "value": true}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": [10.5, 10, "GC6000 series"]}]}, {"resource": "leads", "defaults": [{"id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": "general", "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": true}, {"id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}]}], "custom_mappings": [{"value": "$.root.training.first_aid"}, {"value": "$.root.training.first_aid"}]} responses: "200": - application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}, {"id": "1234", "label": "General Channel", "options": [], "option_type": "group"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}, {"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": "general", "option_type": "simple"}], "value": true}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": "GC5000 series"}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": ["team", "general"], "option_type": "simple"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": 10}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}, {"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} + application/json: {"status_code": 200, "status": "OK", "data": {"id": "crm+salesforce", "service_id": "salesforce", "name": "Salesforce", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "unified_api": "crm", "state": "authorized", "integration_state": "configured", "auth_type": "oauth2", "oauth_grant_type": "authorization_code", "enabled": true, "website": "https://www.salesforce.com", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "authorize_url": "https://unify.apideck.com/vault/authorize/salesforce/?state=", "revoke_url": "https://unify.apideck.com/vault/revoke/salesforce/?state=", "settings": {"instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx"}, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "form_fields": [{"id": "instance_url", "label": "Instance url", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": false}, {"id": "api_key", "label": "API Key", "placeholder": "", "type": "text", "required": true, "custom_field": false, "allow_custom_values": false, "disabled": false, "sensitive": true}], "configuration": [{"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": 12.5, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "option_type": "group"}], "value": 10.5}, {"target": "custom_fields", "id": "ProductInterest", "options": [{"id": "1234", "label": "General Channel", "options": [{"label": "General Channel", "value": true, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": true, "option_type": "simple"}], "option_type": "group"}, {"label": "General Channel", "value": 123, "option_type": "simple"}, {"label": "General Channel", "value": 123, "option_type": "simple"}], "value": true}]}, {"resource": "leads", "defaults": [{"target": "custom_fields", "id": "ProductInterest", "options": [{"label": "General Channel", "value": "general", "option_type": "simple"}], "value": 10.5}]}], "configurable_resources": ["opportunities", "companies", "contacts", "leads"], "resource_schema_support": ["leads"], "resource_settings_support": ["leads"], "settings_required_for_authorization": ["client_id", "client_secret"], "subscriptions": [{"downstream_id": "5f5f5f5f5f5f5f5f5f5f5f5f", "unify_event_types": ["crm.contact.created"], "downstream_event_types": ["contacts.CREATED"], "execute_url": "https://unify.apideck.com/webhook/w/{lookupIdToken}/{serviceId}?e={downstreamEventType}", "created_at": "2020-10-01T12:00:00.000Z"}], "has_guide": true, "created_at": 1615563533390, "custom_mappings": [{"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}, {"id": "hris+employees+first_aid_training", "label": "First Aid Training", "description": "First Aid Training completed after 2019-01-01", "value": "$.root.training.first_aid", "key": "first_aid_training", "required": false, "custom_field": true, "consumer_id": "test_user_id", "example": "Some value"}], "updated_at": 1616662325753}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -9231,11 +9453,11 @@ examples: "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} vault.customFieldsAll: "": parameters: @@ -9496,227 +9718,5 @@ examples: application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} - accounting.attachmentsUpload: - "": - parameters: - path: - reference_type: "invoice" - reference_id: "123456" - query: - raw: false - header: - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - requestBody: - '*/*': "x-file: example.file" - responses: - "201": - application/json: {"status_code": 200, "status": "OK", "service": "google-drive", "resource": "files", "operation": "add", "data": {"id": "12345"}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - basic: - parameters: - path: - reference_type: "invoice" - reference_id: "12345" - query: - raw: false - header: - x-apideck-metadata: "{\"name\":\"document.pdf\",\"description\":\"Invoice attachment\"}" - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - requestBody: - '*/*': "x-file: example.file" - responses: - "201": - application/json: {"status_code": 200, "status": "OK", "service": "google-drive", "resource": "files", "operation": "add", "data": {"id": "12345"}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - accounting.agedCreditorsOne: - "": - parameters: - query: - raw: false - filter: {"customer_id": "123abc", "supplier_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30} - pass_through: {"search": "San Francisco"} - fields: "id,updated_at" - header: - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - responses: - "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "AgedCreditors", "operation": "one", "data": {"report_generated_at": "2024-11-14T12:00:00.000Z", "report_as_of_date": "2024-11-13", "period_count": 4, "period_length": 30, "outstanding_balances": [{"supplier_id": "123", "supplier_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}, {"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}]}, {"supplier_id": "123", "supplier_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}]}, {"supplier_id": "123", "supplier_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800, "transaction_number": "INV-1001"}]}]}]}]}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - crm.pipelinesAdd: - "": - parameters: - query: - raw: false - header: - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - requestBody: - application/json: {"id": "default", "name": "Sales Pipeline", "currency": "USD", "archived": false, "active": false, "display_order": 1, "win_probability_enabled": true, "stages": [{"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} - responses: - "201": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "pipelines", "operation": "add", "data": {"id": "12345"}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} - crm.pipelinesOne: - "": - parameters: - path: - id: "" - query: - raw: false - fields: "id,updated_at" - header: - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - responses: - "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "pipelines", "operation": "one", "data": {"id": "default", "name": "Sales Pipeline", "currency": "USD", "archived": false, "active": false, "display_order": 1, "win_probability_enabled": true, "stages": [{"id": "contractsent", "name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"id": "contractsent", "name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"id": "contractsent", "name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} - crm.pipelinesUpdate: - "": - parameters: - path: - id: "" - query: - raw: false - header: - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - requestBody: - application/json: {"id": "default", "name": "Sales Pipeline", "currency": "USD", "archived": false, "active": false, "display_order": 1, "win_probability_enabled": true, "stages": [{"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}, {"name": "Contract Sent", "value": "CONTRACT_SENT", "win_probability": 50, "display_order": 1}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} - responses: - "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "pipelines", "operation": "update", "data": {"id": "12345"}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - crm.pipelinesDelete: - "": - parameters: - path: - id: "" - query: - raw: false - header: - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - responses: - "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "delete", "data": {"id": "12345"}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - fileStorage.uploadSessionsUpload: - "": - parameters: - path: - id: "" - query: - part_number: 0 - raw: false - header: - x-apideck-consumer-id: "test-consumer" - x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" - x-apideck-service-id: "salesforce" - digest: "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=" - requestBody: - '*/*': "" - responses: - "200": - application/json: {"status_code": 200, "status": "OK", "service": "dropbox", "resource": "UploadSessions", "operation": "one", "data": {"id": "12345"}} - "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} - "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} - "402": - application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} - "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} - "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} - default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} -examplesVersion: 1.0.0 +examplesVersion: 1.0.1 generatedTests: {} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index a84376f2..43ae0f0d 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -18,7 +18,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: true python: - version: 0.10.0 + version: 0.10.1 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index e455ea6f..51b8b339 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.528.1 +speakeasyVersion: 1.531.0 sources: Apideck: sourceNamespace: apideck - sourceRevisionDigest: sha256:1454065cbff9fd4d95b8eb37b140a77a3090a31694d3f7f2553330d6f49f8be3 - sourceBlobDigest: sha256:f90dd147420dc4f66294825009d501bbd970aa0c862202e40ca82a5e4ea9a842 + sourceRevisionDigest: sha256:a1d949f00079636b5a621b20b0d0257e340152123c11e4bd49970bebfb80ac78 + sourceBlobDigest: sha256:906b149a050d755018fe4c94262c6d4f38ceab3045fbee0faca173c5344c7cfb tags: - latest - - speakeasy-sdk-regen-1743420876 + - speakeasy-sdk-regen-1744101387 - 10.14.1 targets: apideck: source: Apideck sourceNamespace: apideck - sourceRevisionDigest: sha256:1454065cbff9fd4d95b8eb37b140a77a3090a31694d3f7f2553330d6f49f8be3 - sourceBlobDigest: sha256:f90dd147420dc4f66294825009d501bbd970aa0c862202e40ca82a5e4ea9a842 + sourceRevisionDigest: sha256:a1d949f00079636b5a621b20b0d0257e340152123c11e4bd49970bebfb80ac78 + sourceBlobDigest: sha256:906b149a050d755018fe4c94262c6d4f38ceab3045fbee0faca173c5344c7cfb codeSamplesNamespace: apideck-python-code-samples - codeSamplesRevisionDigest: sha256:c0fdc3f085a59fd17ef6a4783db4e1858a8d69d8cb43f0b9a9c38dccbf1ec94c + codeSamplesRevisionDigest: sha256:cdf9f27190df71f83569595ba756dba937e801ad21a358c603c153eea9ea4002 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index d41929c2..fa5afd1d 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -168,4 +168,14 @@ Based on: ### Generated - [python v0.10.0] . ### Releases -- [PyPI v0.10.0] https://pypi.org/project/apideck-unify/0.10.0 - . \ No newline at end of file +- [PyPI v0.10.0] https://pypi.org/project/apideck-unify/0.10.0 - . + +## 2025-04-08 08:36:09 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.531.0 (2.568.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.10.1] . +### Releases +- [PyPI v0.10.1] https://pypi.org/project/apideck-unify/0.10.1 - . \ No newline at end of file diff --git a/docs/models/accountingattachmentsuploadrequest.md b/docs/models/accountingattachmentsuploadrequest.md index af4b11a1..7e615ec6 100644 --- a/docs/models/accountingattachmentsuploadrequest.md +++ b/docs/models/accountingattachmentsuploadrequest.md @@ -7,9 +7,9 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `reference_type` | [models.AttachmentReferenceType](../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | -| `request_body` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `x_apideck_metadata` | *Optional[str]* | :heavy_minus_sign: | Metadata to attach to the attachment file (JSON string) | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `request_body` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingbillpaymentsaddrequest.md b/docs/models/accountingbillpaymentsaddrequest.md index f89793bf..b3df5d5e 100644 --- a/docs/models/accountingbillpaymentsaddrequest.md +++ b/docs/models/accountingbillpaymentsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `bill_payment` | [models.BillPaymentInput](../models/billpaymentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `bill_payment` | [models.BillPaymentInput](../models/billpaymentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingbillpaymentsupdaterequest.md b/docs/models/accountingbillpaymentsupdaterequest.md index bc7790de..fe38a4c7 100644 --- a/docs/models/accountingbillpaymentsupdaterequest.md +++ b/docs/models/accountingbillpaymentsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `bill_payment` | [models.BillPaymentInput](../models/billpaymentinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `bill_payment` | [models.BillPaymentInput](../models/billpaymentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingbillsaddrequest.md b/docs/models/accountingbillsaddrequest.md index 5677daab..e9120002 100644 --- a/docs/models/accountingbillsaddrequest.md +++ b/docs/models/accountingbillsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `bill` | [models.BillInput](../models/billinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `bill` | [models.BillInput](../models/billinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingbillsupdaterequest.md b/docs/models/accountingbillsupdaterequest.md index f26dc295..586cf65e 100644 --- a/docs/models/accountingbillsupdaterequest.md +++ b/docs/models/accountingbillsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `bill` | [models.BillInput](../models/billinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `bill` | [models.BillInput](../models/billinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingcreditnotesaddrequest.md b/docs/models/accountingcreditnotesaddrequest.md index cda2b4ca..b46f9a07 100644 --- a/docs/models/accountingcreditnotesaddrequest.md +++ b/docs/models/accountingcreditnotesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `credit_note` | [models.CreditNoteInput](../models/creditnoteinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `credit_note` | [models.CreditNoteInput](../models/creditnoteinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingcreditnotesupdaterequest.md b/docs/models/accountingcreditnotesupdaterequest.md index 92ce55dc..5cd2fd74 100644 --- a/docs/models/accountingcreditnotesupdaterequest.md +++ b/docs/models/accountingcreditnotesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `credit_note` | [models.CreditNoteInput](../models/creditnoteinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `credit_note` | [models.CreditNoteInput](../models/creditnoteinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingcustomersaddrequest.md b/docs/models/accountingcustomersaddrequest.md index 6721273a..b182be02 100644 --- a/docs/models/accountingcustomersaddrequest.md +++ b/docs/models/accountingcustomersaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `customer` | [models.CustomerInput](../models/customerinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `customer` | [models.CustomerInput](../models/customerinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingcustomersupdaterequest.md b/docs/models/accountingcustomersupdaterequest.md index 5b64e17a..b1034b8d 100644 --- a/docs/models/accountingcustomersupdaterequest.md +++ b/docs/models/accountingcustomersupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `customer` | [models.CustomerInput](../models/customerinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `customer` | [models.CustomerInput](../models/customerinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingdepartmentsaddrequest.md b/docs/models/accountingdepartmentsaddrequest.md index 91b7dc5d..4f1f03d0 100644 --- a/docs/models/accountingdepartmentsaddrequest.md +++ b/docs/models/accountingdepartmentsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_department` | [models.AccountingDepartmentInput](../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `accounting_department` | [models.AccountingDepartmentInput](../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingdepartmentsupdaterequest.md b/docs/models/accountingdepartmentsupdaterequest.md index 8462bfa4..b5050bf0 100644 --- a/docs/models/accountingdepartmentsupdaterequest.md +++ b/docs/models/accountingdepartmentsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `accounting_department` | [models.AccountingDepartmentInput](../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `accounting_department` | [models.AccountingDepartmentInput](../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingexpensesaddrequest.md b/docs/models/accountingexpensesaddrequest.md index 5617eb04..2a304957 100644 --- a/docs/models/accountingexpensesaddrequest.md +++ b/docs/models/accountingexpensesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `expense` | [models.ExpenseInput](../models/expenseinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `expense` | [models.ExpenseInput](../models/expenseinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingexpensesupdaterequest.md b/docs/models/accountingexpensesupdaterequest.md index d66ba602..b88eee0f 100644 --- a/docs/models/accountingexpensesupdaterequest.md +++ b/docs/models/accountingexpensesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `expense` | [models.ExpenseInput](../models/expenseinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `expense` | [models.ExpenseInput](../models/expenseinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountinginvoiceitemsaddrequest.md b/docs/models/accountinginvoiceitemsaddrequest.md index 215f7089..40cc6e18 100644 --- a/docs/models/accountinginvoiceitemsaddrequest.md +++ b/docs/models/accountinginvoiceitemsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `invoice_item` | [models.InvoiceItemInput](../models/invoiceiteminput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `invoice_item` | [models.InvoiceItemInput](../models/invoiceiteminput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountinginvoiceitemsupdaterequest.md b/docs/models/accountinginvoiceitemsupdaterequest.md index 47da9323..d07653f1 100644 --- a/docs/models/accountinginvoiceitemsupdaterequest.md +++ b/docs/models/accountinginvoiceitemsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `invoice_item` | [models.InvoiceItemInput](../models/invoiceiteminput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `invoice_item` | [models.InvoiceItemInput](../models/invoiceiteminput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountinginvoicesaddrequest.md b/docs/models/accountinginvoicesaddrequest.md index 3e720c8b..9dc40708 100644 --- a/docs/models/accountinginvoicesaddrequest.md +++ b/docs/models/accountinginvoicesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `invoice` | [models.InvoiceInput](../models/invoiceinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `invoice` | [models.InvoiceInput](../models/invoiceinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountinginvoicesupdaterequest.md b/docs/models/accountinginvoicesupdaterequest.md index 94bbfb6e..dad9ad9b 100644 --- a/docs/models/accountinginvoicesupdaterequest.md +++ b/docs/models/accountinginvoicesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `invoice` | [models.InvoiceInput](../models/invoiceinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `invoice` | [models.InvoiceInput](../models/invoiceinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingjournalentriesaddrequest.md b/docs/models/accountingjournalentriesaddrequest.md index d48061b0..254fecc5 100644 --- a/docs/models/accountingjournalentriesaddrequest.md +++ b/docs/models/accountingjournalentriesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `journal_entry` | [models.JournalEntryInput](../models/journalentryinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `journal_entry` | [models.JournalEntryInput](../models/journalentryinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingjournalentriesupdaterequest.md b/docs/models/accountingjournalentriesupdaterequest.md index 4d3b0bd3..6b0310aa 100644 --- a/docs/models/accountingjournalentriesupdaterequest.md +++ b/docs/models/accountingjournalentriesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `journal_entry` | [models.JournalEntryInput](../models/journalentryinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `journal_entry` | [models.JournalEntryInput](../models/journalentryinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingledgeraccountsaddrequest.md b/docs/models/accountingledgeraccountsaddrequest.md index b3c09ddc..9ce079cc 100644 --- a/docs/models/accountingledgeraccountsaddrequest.md +++ b/docs/models/accountingledgeraccountsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ledger_account` | [models.LedgerAccountInput](../models/ledgeraccountinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `ledger_account` | [models.LedgerAccountInput](../models/ledgeraccountinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingledgeraccountsupdaterequest.md b/docs/models/accountingledgeraccountsupdaterequest.md index 4ce90327..17753d56 100644 --- a/docs/models/accountingledgeraccountsupdaterequest.md +++ b/docs/models/accountingledgeraccountsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `ledger_account` | [models.LedgerAccountInput](../models/ledgeraccountinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `ledger_account` | [models.LedgerAccountInput](../models/ledgeraccountinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountinglocationsaddrequest.md b/docs/models/accountinglocationsaddrequest.md index ff0ba131..45464afb 100644 --- a/docs/models/accountinglocationsaddrequest.md +++ b/docs/models/accountinglocationsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_location` | [models.AccountingLocationInput](../models/accountinglocationinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `accounting_location` | [models.AccountingLocationInput](../models/accountinglocationinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountinglocationsupdaterequest.md b/docs/models/accountinglocationsupdaterequest.md index aacb4c67..894b264a 100644 --- a/docs/models/accountinglocationsupdaterequest.md +++ b/docs/models/accountinglocationsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `accounting_location` | [models.AccountingLocationInput](../models/accountinglocationinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `accounting_location` | [models.AccountingLocationInput](../models/accountinglocationinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingpaymentsaddrequest.md b/docs/models/accountingpaymentsaddrequest.md index ee392587..bc7c531b 100644 --- a/docs/models/accountingpaymentsaddrequest.md +++ b/docs/models/accountingpaymentsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `payment` | [models.PaymentInput](../models/paymentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `payment` | [models.PaymentInput](../models/paymentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingpaymentsupdaterequest.md b/docs/models/accountingpaymentsupdaterequest.md index 7085e5d3..a7e9162e 100644 --- a/docs/models/accountingpaymentsupdaterequest.md +++ b/docs/models/accountingpaymentsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `payment` | [models.PaymentInput](../models/paymentinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `payment` | [models.PaymentInput](../models/paymentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingpurchaseordersaddrequest.md b/docs/models/accountingpurchaseordersaddrequest.md index fe106156..8e51a714 100644 --- a/docs/models/accountingpurchaseordersaddrequest.md +++ b/docs/models/accountingpurchaseordersaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `purchase_order` | [models.PurchaseOrderInput](../models/purchaseorderinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `purchase_order` | [models.PurchaseOrderInput](../models/purchaseorderinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingpurchaseordersupdaterequest.md b/docs/models/accountingpurchaseordersupdaterequest.md index 77eca894..8fa74f7d 100644 --- a/docs/models/accountingpurchaseordersupdaterequest.md +++ b/docs/models/accountingpurchaseordersupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `purchase_order` | [models.PurchaseOrderInput](../models/purchaseorderinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `purchase_order` | [models.PurchaseOrderInput](../models/purchaseorderinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingsubsidiariesaddrequest.md b/docs/models/accountingsubsidiariesaddrequest.md index 82fc1d0e..53ec67f8 100644 --- a/docs/models/accountingsubsidiariesaddrequest.md +++ b/docs/models/accountingsubsidiariesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `subsidiary` | [models.SubsidiaryInput](../models/subsidiaryinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `subsidiary` | [models.SubsidiaryInput](../models/subsidiaryinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingsubsidiariesupdaterequest.md b/docs/models/accountingsubsidiariesupdaterequest.md index 9525c98d..f23ff28e 100644 --- a/docs/models/accountingsubsidiariesupdaterequest.md +++ b/docs/models/accountingsubsidiariesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `subsidiary` | [models.SubsidiaryInput](../models/subsidiaryinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `subsidiary` | [models.SubsidiaryInput](../models/subsidiaryinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingsuppliersaddrequest.md b/docs/models/accountingsuppliersaddrequest.md index 669dbc7e..80bec7c1 100644 --- a/docs/models/accountingsuppliersaddrequest.md +++ b/docs/models/accountingsuppliersaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `supplier` | [models.SupplierInput](../models/supplierinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `supplier` | [models.SupplierInput](../models/supplierinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingsuppliersupdaterequest.md b/docs/models/accountingsuppliersupdaterequest.md index a6279807..391d38f5 100644 --- a/docs/models/accountingsuppliersupdaterequest.md +++ b/docs/models/accountingsuppliersupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `supplier` | [models.SupplierInput](../models/supplierinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `supplier` | [models.SupplierInput](../models/supplierinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingtaxratesaddrequest.md b/docs/models/accountingtaxratesaddrequest.md index 6859a0c7..c3db4a97 100644 --- a/docs/models/accountingtaxratesaddrequest.md +++ b/docs/models/accountingtaxratesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `tax_rate` | [models.TaxRateInput](../models/taxrateinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `tax_rate` | [models.TaxRateInput](../models/taxrateinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingtaxratesupdaterequest.md b/docs/models/accountingtaxratesupdaterequest.md index 16194067..4c3c6231 100644 --- a/docs/models/accountingtaxratesupdaterequest.md +++ b/docs/models/accountingtaxratesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `tax_rate` | [models.TaxRateInput](../models/taxrateinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `tax_rate` | [models.TaxRateInput](../models/taxrateinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingtrackingcategoriesaddrequest.md b/docs/models/accountingtrackingcategoriesaddrequest.md index f09a1e40..2ff9ecd8 100644 --- a/docs/models/accountingtrackingcategoriesaddrequest.md +++ b/docs/models/accountingtrackingcategoriesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `tracking_category` | [models.TrackingCategoryInput](../models/trackingcategoryinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `tracking_category` | [models.TrackingCategoryInput](../models/trackingcategoryinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/accountingtrackingcategoriesupdaterequest.md b/docs/models/accountingtrackingcategoriesupdaterequest.md index 2837eba7..2a7f9cfb 100644 --- a/docs/models/accountingtrackingcategoriesupdaterequest.md +++ b/docs/models/accountingtrackingcategoriesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `tracking_category` | [models.TrackingCategoryInput](../models/trackingcategoryinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `tracking_category` | [models.TrackingCategoryInput](../models/trackingcategoryinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/activity.md b/docs/models/activity.md index b9f63997..6d95cdaf 100644 --- a/docs/models/activity.md +++ b/docs/models/activity.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [Nullable[models.ActivityType]](../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting | | `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier of the activity | 12345 | | `downstream_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | | `activity_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the activity | 2021-05-01T12:00:00.000Z | @@ -24,6 +23,7 @@ | `product_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The product related to the activity | 12345 | | `solution_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The solution related to the activity | 12345 | | `custom_object_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom object related to the activity | 12345 | +| `type` | [Nullable[models.ActivityType]](../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The title of the activity | Meeting | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the activity | More info about the meeting | | `note` | *OptionalNullable[str]* | :heavy_minus_sign: | An internal note about the activity | An internal note about the meeting | diff --git a/docs/models/activityinput.md b/docs/models/activityinput.md index 6deff256..4b730640 100644 --- a/docs/models/activityinput.md +++ b/docs/models/activityinput.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [Nullable[models.ActivityType]](../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting | | `activity_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the activity | 2021-05-01T12:00:00.000Z | | `duration_seconds` | *OptionalNullable[int]* | :heavy_minus_sign: | The duration of the activity in seconds | 1800 | | `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The user related to the activity | 12345 | @@ -22,6 +21,7 @@ | `product_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The product related to the activity | 12345 | | `solution_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The solution related to the activity | 12345 | | `custom_object_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom object related to the activity | 12345 | +| `type` | [Nullable[models.ActivityType]](../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The title of the activity | Meeting | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the activity | More info about the meeting | | `note` | *OptionalNullable[str]* | :heavy_minus_sign: | An internal note about the activity | An internal note about the meeting | diff --git a/docs/models/application.md b/docs/models/application.md index 98f80a4e..589014fa 100644 --- a/docs/models/application.md +++ b/docs/models/application.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `applicant_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 | | `job_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 | -| `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `status` | [OptionalNullable[models.ApplicationStatus]](../models/applicationstatus.md) | :heavy_minus_sign: | N/A | open | | `stage` | [Optional[models.Stage]](../models/stage.md) | :heavy_minus_sign: | N/A | | | `custom_mappings` | [OptionalNullable[models.CustomMappings]](../models/custommappings.md) | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | diff --git a/docs/models/atsapplicantsaddrequest.md b/docs/models/atsapplicantsaddrequest.md index 1c81f866..1f4d6003 100644 --- a/docs/models/atsapplicantsaddrequest.md +++ b/docs/models/atsapplicantsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `applicant` | [models.ApplicantInput](../models/applicantinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `applicant` | [models.ApplicantInput](../models/applicantinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/atsapplicantsupdaterequest.md b/docs/models/atsapplicantsupdaterequest.md index 61f86a2e..065a1f29 100644 --- a/docs/models/atsapplicantsupdaterequest.md +++ b/docs/models/atsapplicantsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `applicant` | [models.ApplicantInput](../models/applicantinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `applicant` | [models.ApplicantInput](../models/applicantinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/atsapplicationsaddrequest.md b/docs/models/atsapplicationsaddrequest.md index 354c14f9..789ccb8d 100644 --- a/docs/models/atsapplicationsaddrequest.md +++ b/docs/models/atsapplicationsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `application` | [models.ApplicationInput](../models/applicationinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `application` | [models.ApplicationInput](../models/applicationinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/atsapplicationsupdaterequest.md b/docs/models/atsapplicationsupdaterequest.md index 8c7f82ae..b66b4dc5 100644 --- a/docs/models/atsapplicationsupdaterequest.md +++ b/docs/models/atsapplicationsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `application` | [models.ApplicationInput](../models/applicationinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `application` | [models.ApplicationInput](../models/applicationinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/billpayment.md b/docs/models/billpayment.md index 9ad08df2..0702cec5 100644 --- a/docs/models/billpayment.md +++ b/docs/models/billpayment.md @@ -6,16 +6,16 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | A unique identifier for an object. | 12345 | -| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | -| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `downstream_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | | `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | +| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional transaction reference message ie: Debit remittance detail. | 123456 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `payment_method_reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message returned by payment method on processing | 123456 | | `payment_method_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `account` | [OptionalNullable[models.LinkedLedgerAccount]](../models/linkedledgeraccount.md) | :heavy_minus_sign: | N/A | | +| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `supplier` | [OptionalNullable[models.LinkedSupplier]](../models/linkedsupplier.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | diff --git a/docs/models/billpaymentinput.md b/docs/models/billpaymentinput.md index 96962a61..2db0f6f3 100644 --- a/docs/models/billpaymentinput.md +++ b/docs/models/billpaymentinput.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | -| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | +| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional transaction reference message ie: Debit remittance detail. | 123456 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `payment_method_reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message returned by payment method on processing | 123456 | | `payment_method_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | +| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | diff --git a/docs/models/company.md b/docs/models/company.md index e80a7748..44360e88 100644 --- a/docs/models/company.md +++ b/docs/models/company.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *Nullable[str]* | :heavy_check_mark: | Name of the company | SpaceX | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the company | 12345 | +| `name` | *Nullable[str]* | :heavy_check_mark: | Name of the company | SpaceX | | `interaction_count` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of interactions | 1 | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Owner ID | 12345 | | `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The Image URL of the company | https://www.spacex.com/static/images/share.jpg | diff --git a/docs/models/connectorapiresourcecoverageonerequest.md b/docs/models/connectorapiresourcecoverageonerequest.md index 0667b110..e228e4e1 100644 --- a/docs/models/connectorapiresourcecoverageonerequest.md +++ b/docs/models/connectorapiresourcecoverageonerequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | \ No newline at end of file diff --git a/docs/models/connectorapiresourcesonerequest.md b/docs/models/connectorapiresourcesonerequest.md index d7e0c589..e4ab301f 100644 --- a/docs/models/connectorapiresourcesonerequest.md +++ b/docs/models/connectorapiresourcesonerequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | \ No newline at end of file diff --git a/docs/models/connectorapisonerequest.md b/docs/models/connectorapisonerequest.md index bd06dd28..aa76a987 100644 --- a/docs/models/connectorapisonerequest.md +++ b/docs/models/connectorapisonerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | \ No newline at end of file diff --git a/docs/models/connectorconnectordocsonerequest.md b/docs/models/connectorconnectordocsonerequest.md index fa6fad6c..fc91b5af 100644 --- a/docs/models/connectorconnectordocsonerequest.md +++ b/docs/models/connectorconnectordocsonerequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `doc_id` | *str* | :heavy_check_mark: | ID of the Doc | application_owner+oauth_credentials | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `doc_id` | *str* | :heavy_check_mark: | ID of the Doc | application_owner+oauth_credentials | \ No newline at end of file diff --git a/docs/models/connectorconnectorresourcesonerequest.md b/docs/models/connectorconnectorresourcesonerequest.md index 5e2fa75a..c9b2bfb6 100644 --- a/docs/models/connectorconnectorresourcesonerequest.md +++ b/docs/models/connectorconnectorresourcesonerequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `unified_api` | [Optional[models.UnifiedAPIID]](../models/unifiedapiid.md) | :heavy_minus_sign: | Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs | crm | \ No newline at end of file diff --git a/docs/models/connectorconnectorsonerequest.md b/docs/models/connectorconnectorsonerequest.md index 0a24f2ee..c92eb262 100644 --- a/docs/models/connectorconnectorsonerequest.md +++ b/docs/models/connectorconnectorsonerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | \ No newline at end of file diff --git a/docs/models/contact.md b/docs/models/contact.md index d9640a7d..02f7b21b 100644 --- a/docs/models/contact.md +++ b/docs/models/contact.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *Nullable[str]* | :heavy_check_mark: | Full name of the contact. | Elon Musk | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the contact. | 12345 | +| `name` | *Nullable[str]* | :heavy_check_mark: | Full name of the contact. | Elon Musk | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the contact. | 54321 | | `type` | [OptionalNullable[models.ContactType]](../models/contacttype.md) | :heavy_minus_sign: | The type of the contact. | personal | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company the contact is associated with. | 23456 | diff --git a/docs/models/copyfolderrequest.md b/docs/models/copyfolderrequest.md index 9304ea5e..211d14c4 100644 --- a/docs/models/copyfolderrequest.md +++ b/docs/models/copyfolderrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of the folder. | Documents | +| `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | | `pass_through` | List[[models.PassThroughBody](../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | \ No newline at end of file diff --git a/docs/models/costofgoodssold.md b/docs/models/costofgoodssold.md index aadc1b59..ad6741fe 100644 --- a/docs/models/costofgoodssold.md +++ b/docs/models/costofgoodssold.md @@ -7,9 +7,9 @@ The cost of goods sold accounts | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | -| `records` | *Any* | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `code` | *Optional[str]* | :heavy_minus_sign: | The account code of the account | 1100 | | `title` | *Optional[str]* | :heavy_minus_sign: | The name of the account. | Current assets | -| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | \ No newline at end of file +| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | +| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | +| `records` | *Any* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/createfolderrequest.md b/docs/models/createfolderrequest.md index 373d4b11..1049d87b 100644 --- a/docs/models/createfolderrequest.md +++ b/docs/models/createfolderrequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *str* | :heavy_check_mark: | The name of the folder. | Documents | -| `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | | `description` | *Optional[str]* | :heavy_minus_sign: | Optional description of the folder. | My Personal Documents | +| `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | | `drive_id` | *Optional[str]* | :heavy_minus_sign: | ID of the drive to create the folder in. | 1234 | | `pass_through` | List[[models.PassThroughBody](../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | \ No newline at end of file diff --git a/docs/models/createuploadsessionrequest.md b/docs/models/createuploadsessionrequest.md index 5ac97b5c..46a292d9 100644 --- a/docs/models/createuploadsessionrequest.md +++ b/docs/models/createuploadsessionrequest.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *str* | :heavy_check_mark: | The name of the file. | Documents | | `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | -| `size` | *Nullable[int]* | :heavy_check_mark: | The size of the file in bytes | 1810673 | | `drive_id` | *Optional[str]* | :heavy_minus_sign: | ID of the drive to upload to. | 1234 | +| `size` | *Nullable[int]* | :heavy_check_mark: | The size of the file in bytes | 1810673 | | `pass_through` | List[[models.PassThroughBody](../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | \ No newline at end of file diff --git a/docs/models/createwebhookrequest.md b/docs/models/createwebhookrequest.md index 37b4c963..c3502b88 100644 --- a/docs/models/createwebhookrequest.md +++ b/docs/models/createwebhookrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | | `unified_api` | [models.UnifiedAPIID](../models/unifiedapiid.md) | :heavy_check_mark: | Name of Apideck Unified API | crm | | `status` | [models.Status](../models/status.md) | :heavy_check_mark: | The status of the webhook. | enabled | | `delivery_url` | *str* | :heavy_check_mark: | The delivery url of the webhook endpoint. | https://example.com/my/webhook/endpoint | -| `events` | List[[models.WebhookEventType](../models/webhookeventtype.md)] | :heavy_check_mark: | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | [
"vault.connection.created",
"vault.connection.updated"
] | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | \ No newline at end of file +| `events` | List[[models.WebhookEventType](../models/webhookeventtype.md)] | :heavy_check_mark: | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | [
"vault.connection.created",
"vault.connection.updated"
] | \ No newline at end of file diff --git a/docs/models/creditnote.md b/docs/models/creditnote.md index b0857f56..d157edcd 100644 --- a/docs/models/creditnote.md +++ b/docs/models/creditnote.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | Unique identifier representing the entity | 123456 | -| `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Credit note number. | OIT00546 | | `customer` | [OptionalNullable[models.LinkedCustomer]](../models/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | @@ -14,6 +13,7 @@ | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | | `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 | +| `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 | | `total_tax` | *OptionalNullable[float]* | :heavy_minus_sign: | Total tax amount applied to this invoice. | 2500 | | `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `balance` | *OptionalNullable[float]* | :heavy_minus_sign: | The balance reflecting any payments made against the transaction. | 27500 | diff --git a/docs/models/creditnoteinput.md b/docs/models/creditnoteinput.md index 968b065e..0280ba26 100644 --- a/docs/models/creditnoteinput.md +++ b/docs/models/creditnoteinput.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Credit note number. | OIT00546 | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | @@ -13,6 +12,7 @@ | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | | `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 | +| `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 | | `total_tax` | *OptionalNullable[float]* | :heavy_minus_sign: | Total tax amount applied to this invoice. | 2500 | | `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `balance` | *OptionalNullable[float]* | :heavy_minus_sign: | The balance reflecting any payments made against the transaction. | 27500 | diff --git a/docs/models/crmactivitiesaddrequest.md b/docs/models/crmactivitiesaddrequest.md index ae123a2d..bd50dc0f 100644 --- a/docs/models/crmactivitiesaddrequest.md +++ b/docs/models/crmactivitiesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `activity` | [models.ActivityInput](../models/activityinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `activity` | [models.ActivityInput](../models/activityinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmactivitiesupdaterequest.md b/docs/models/crmactivitiesupdaterequest.md index c27872c1..aca52b99 100644 --- a/docs/models/crmactivitiesupdaterequest.md +++ b/docs/models/crmactivitiesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `activity` | [models.ActivityInput](../models/activityinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `activity` | [models.ActivityInput](../models/activityinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmcompaniesaddrequest.md b/docs/models/crmcompaniesaddrequest.md index d2c8252d..35539620 100644 --- a/docs/models/crmcompaniesaddrequest.md +++ b/docs/models/crmcompaniesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `company` | [models.CompanyInput](../models/companyinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `company` | [models.CompanyInput](../models/companyinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmcompaniesupdaterequest.md b/docs/models/crmcompaniesupdaterequest.md index 671e0b59..1fc2ac49 100644 --- a/docs/models/crmcompaniesupdaterequest.md +++ b/docs/models/crmcompaniesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `company` | [models.CompanyInput](../models/companyinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `company` | [models.CompanyInput](../models/companyinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmcontactsaddrequest.md b/docs/models/crmcontactsaddrequest.md index c639e5e7..f9f0f3fc 100644 --- a/docs/models/crmcontactsaddrequest.md +++ b/docs/models/crmcontactsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `contact` | [models.ContactInput](../models/contactinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `contact` | [models.ContactInput](../models/contactinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmcontactsupdaterequest.md b/docs/models/crmcontactsupdaterequest.md index 8ede417b..e8108087 100644 --- a/docs/models/crmcontactsupdaterequest.md +++ b/docs/models/crmcontactsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `contact` | [models.ContactInput](../models/contactinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `contact` | [models.ContactInput](../models/contactinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmleadsaddrequest.md b/docs/models/crmleadsaddrequest.md index e60b46f8..aada8f88 100644 --- a/docs/models/crmleadsaddrequest.md +++ b/docs/models/crmleadsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `lead` | [models.LeadInput](../models/leadinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `lead` | [models.LeadInput](../models/leadinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmleadsupdaterequest.md b/docs/models/crmleadsupdaterequest.md index 2bd3b814..b823dc94 100644 --- a/docs/models/crmleadsupdaterequest.md +++ b/docs/models/crmleadsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `lead` | [models.LeadInput](../models/leadinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `lead` | [models.LeadInput](../models/leadinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmnotesaddrequest.md b/docs/models/crmnotesaddrequest.md index f6254ed4..7b030299 100644 --- a/docs/models/crmnotesaddrequest.md +++ b/docs/models/crmnotesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `note` | [models.NoteInput](../models/noteinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `note` | [models.NoteInput](../models/noteinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmnotesupdaterequest.md b/docs/models/crmnotesupdaterequest.md index 020f6b24..999533f4 100644 --- a/docs/models/crmnotesupdaterequest.md +++ b/docs/models/crmnotesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `note` | [models.NoteInput](../models/noteinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `note` | [models.NoteInput](../models/noteinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmopportunitiesaddrequest.md b/docs/models/crmopportunitiesaddrequest.md index 073388f3..408a51e1 100644 --- a/docs/models/crmopportunitiesaddrequest.md +++ b/docs/models/crmopportunitiesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `opportunity` | [models.OpportunityInput](../models/opportunityinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `opportunity` | [models.OpportunityInput](../models/opportunityinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmopportunitiesupdaterequest.md b/docs/models/crmopportunitiesupdaterequest.md index 9181789b..d16d2b93 100644 --- a/docs/models/crmopportunitiesupdaterequest.md +++ b/docs/models/crmopportunitiesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `opportunity` | [models.OpportunityInput](../models/opportunityinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `opportunity` | [models.OpportunityInput](../models/opportunityinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmpipelinesaddrequest.md b/docs/models/crmpipelinesaddrequest.md index 1b5f3517..53542dea 100644 --- a/docs/models/crmpipelinesaddrequest.md +++ b/docs/models/crmpipelinesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `pipeline` | [models.PipelineInput](../models/pipelineinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `pipeline` | [models.PipelineInput](../models/pipelineinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmpipelinesupdaterequest.md b/docs/models/crmpipelinesupdaterequest.md index aa7f8588..cabd737e 100644 --- a/docs/models/crmpipelinesupdaterequest.md +++ b/docs/models/crmpipelinesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `pipeline` | [models.PipelineInput](../models/pipelineinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `pipeline` | [models.PipelineInput](../models/pipelineinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmusersaddrequest.md b/docs/models/crmusersaddrequest.md index 27bcc84d..4c581809 100644 --- a/docs/models/crmusersaddrequest.md +++ b/docs/models/crmusersaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | [models.UserInput](../models/userinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `user` | [models.UserInput](../models/userinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/crmusersupdaterequest.md b/docs/models/crmusersupdaterequest.md index be12daa4..89c65ca6 100644 --- a/docs/models/crmusersupdaterequest.md +++ b/docs/models/crmusersupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `user` | [models.UserInput](../models/userinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `user` | [models.UserInput](../models/userinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/ecommerceorderlineitem.md b/docs/models/ecommerceorderlineitem.md index 46419932..cfcaa4ab 100644 --- a/docs/models/ecommerceorderlineitem.md +++ b/docs/models/ecommerceorderlineitem.md @@ -7,15 +7,14 @@ A single line item of an ecommerce order, representing a product or variant with | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `name` | *Nullable[str]* | :heavy_check_mark: | The name of the product or variant associated with the line item. | Midnight 16inch MacBook Pro | -| `quantity` | *Nullable[str]* | :heavy_check_mark: | The quantity of the product or variant associated with the line item. | 2 | -| `total_amount` | *Nullable[str]* | :heavy_check_mark: | The total amount for the product(s) or variant associated with the line item, including taxes and discounts. | 43.18 | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `product_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for the product associated with the line item. | def456 | | `variant_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for the variant of the product associated with the line item, if applicable. | ghi789 | | `sku` | *OptionalNullable[str]* | :heavy_minus_sign: | The SKU of the product or variant associated with the line item. | MBP123-16GB-SILVER-13 | +| `name` | *Nullable[str]* | :heavy_check_mark: | The name of the product or variant associated with the line item. | Midnight 16inch MacBook Pro | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | The description of the product or variant associated with the line item. | Powerful and portable, the MacBook Pro is perfect for professionals and creatives. | | `options` | List[[models.Options](../models/options.md)] | :heavy_minus_sign: | N/A | | +| `quantity` | *Nullable[str]* | :heavy_check_mark: | The quantity of the product or variant associated with the line item. | 2 | | `unit_price` | *OptionalNullable[str]* | :heavy_minus_sign: | The unit price of the product or variant associated with the line item. | 19.99 | | `tax_rate` | *OptionalNullable[str]* | :heavy_minus_sign: | The tax rate applied to the product or variant associated with the line item. | 0.08 | | `tax_amount` | *OptionalNullable[str]* | :heavy_minus_sign: | The total tax amount applied to the product or variant associated with the line item. | 1.6 | @@ -23,4 +22,5 @@ A single line item of an ecommerce order, representing a product or variant with | `refunded_amount` | *OptionalNullable[str]* | :heavy_minus_sign: | The amount of the line item that has been refunded. | 0 | | `refunded_quantity` | *OptionalNullable[str]* | :heavy_minus_sign: | The quantity of the line item that has been refunded. | 0 | | `sub_total` | *OptionalNullable[str]* | :heavy_minus_sign: | The sub total for the product(s) or variant associated with the line item, excluding taxes and discounts. | 43.18 | +| `total_amount` | *Nullable[str]* | :heavy_check_mark: | The total amount for the product(s) or variant associated with the line item, including taxes and discounts. | 43.18 | | `discounts` | List[[models.EcommerceDiscount](../models/ecommercediscount.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/email.md b/docs/models/email.md index 6ecfa36e..71cf011e 100644 --- a/docs/models/email.md +++ b/docs/models/email.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `email` | *Nullable[str]* | :heavy_check_mark: | Email address | elon@musk.com | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier for the email address | 123 | +| `email` | *Nullable[str]* | :heavy_check_mark: | Email address | elon@musk.com | | `type` | [OptionalNullable[models.EmailType]](../models/emailtype.md) | :heavy_minus_sign: | Email type | primary | \ No newline at end of file diff --git a/docs/models/employeepayroll.md b/docs/models/employeepayroll.md index 6f1e8b1b..794a7ace 100644 --- a/docs/models/employeepayroll.md +++ b/docs/models/employeepayroll.md @@ -6,12 +6,12 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `id` | *Nullable[str]* | :heavy_check_mark: | A unique identifier for an object. | 12345 | +| `employee_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the employee | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of the company. | 23456 | | `processed` | *Nullable[bool]* | :heavy_check_mark: | Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. | false | +| `processed_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date the payroll was processed. | 2022-04-08 | | `check_date` | *Nullable[str]* | :heavy_check_mark: | The date on which employees will be paid for the payroll. | 2022-04-08 | | `start_date` | *Nullable[str]* | :heavy_check_mark: | The start date, inclusive, of the pay period. | 2022-04-08 | | `end_date` | *Nullable[str]* | :heavy_check_mark: | The end date, inclusive, of the pay period. | 2022-04-21 | -| `employee_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the employee | 12345 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of the company. | 23456 | -| `processed_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date the payroll was processed. | 2022-04-08 | | `totals` | [Optional[models.PayrollTotals]](../models/payrolltotals.md) | :heavy_minus_sign: | The overview of the payroll totals. | | | `compensations` | List[[models.Compensation](../models/compensation.md)] | :heavy_minus_sign: | An array of compensations for the payroll. | | \ No newline at end of file diff --git a/docs/models/expense.md b/docs/models/expense.md index a0873405..93cef92e 100644 --- a/docs/models/expense.md +++ b/docs/models/expense.md @@ -5,11 +5,10 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | -| `account_id` | *str* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 | -| `line_items` | List[[models.ExpenseLineItem](../models/expenselineitem.md)] | :heavy_check_mark: | Expense line items linked to this expense. | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number. | OIT00546 | +| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | +| `account_id` | *str* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 | | `customer_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. | 12345 | | `supplier_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the supplier this entity is linked to. | 12345 | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | @@ -21,6 +20,7 @@ | `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | The memo of the expense. | For travel expenses incurred on 2024-05-15 | | `tax_rate` | [Optional[models.LinkedTaxRate]](../models/linkedtaxrate.md) | :heavy_minus_sign: | N/A | | | `total_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | The total amount of the expense line item. | 275 | +| `line_items` | List[[models.ExpenseLineItem](../models/expenselineitem.md)] | :heavy_check_mark: | Expense line items linked to this expense. | | | `custom_fields` | List[[models.CustomField](../models/customfield.md)] | :heavy_minus_sign: | N/A | | | `custom_mappings` | [OptionalNullable[models.CustomMappings]](../models/custommappings.md) | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The date and time when the object was last updated. | 2020-09-30T07:43:32.000Z | diff --git a/docs/models/expenseinput.md b/docs/models/expenseinput.md index ca00928b..91e5773e 100644 --- a/docs/models/expenseinput.md +++ b/docs/models/expenseinput.md @@ -5,10 +5,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number. | OIT00546 | | `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `account_id` | *str* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 | -| `line_items` | List[[models.ExpenseLineItemInput](../models/expenselineiteminput.md)] | :heavy_check_mark: | Expense line items linked to this expense. | | -| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number. | OIT00546 | | `customer_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. | 12345 | | `supplier_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the supplier this entity is linked to. | 12345 | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | @@ -20,6 +19,7 @@ | `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | The memo of the expense. | For travel expenses incurred on 2024-05-15 | | `tax_rate` | [Optional[models.LinkedTaxRateInput]](../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | | | `total_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | The total amount of the expense line item. | 275 | +| `line_items` | List[[models.ExpenseLineItemInput](../models/expenselineiteminput.md)] | :heavy_check_mark: | Expense line items linked to this expense. | | | `custom_fields` | List[[models.CustomField](../models/customfield.md)] | :heavy_minus_sign: | N/A | | | `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 | | `pass_through` | List[[models.PassThroughBody](../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | \ No newline at end of file diff --git a/docs/models/expenselineitem.md b/docs/models/expenselineitem.md index 7be4c55b..18627295 100644 --- a/docs/models/expenselineitem.md +++ b/docs/models/expenselineitem.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the expense line item. | 275 | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `account_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the ledger account. | 123456 | @@ -15,4 +14,5 @@ | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | | `tax_rate` | [Optional[models.LinkedTaxRate]](../models/linkedtaxrate.md) | :heavy_minus_sign: | N/A | | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | The expense line item description | Travel US. | +| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the expense line item. | 275 | | `billable` | *Optional[bool]* | :heavy_minus_sign: | Boolean that indicates if the line item is billable or not. | true | \ No newline at end of file diff --git a/docs/models/expenselineiteminput.md b/docs/models/expenselineiteminput.md index 40282e05..9382d379 100644 --- a/docs/models/expenselineiteminput.md +++ b/docs/models/expenselineiteminput.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the expense line item. | 275 | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `account_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the ledger account. | 123456 | | `customer_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the customer this expense item is linked to. | 12345 | @@ -14,4 +13,5 @@ | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | | `tax_rate` | [Optional[models.LinkedTaxRateInput]](../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | The expense line item description | Travel US. | +| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the expense line item. | 275 | | `billable` | *Optional[bool]* | :heavy_minus_sign: | Boolean that indicates if the line item is billable or not. | true | \ No newline at end of file diff --git a/docs/models/expensesmodel.md b/docs/models/expensesmodel.md index e96fe167..e76873d5 100644 --- a/docs/models/expensesmodel.md +++ b/docs/models/expensesmodel.md @@ -7,9 +7,9 @@ The operating expenses accounts | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | -| `records` | *Any* | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `code` | *Optional[str]* | :heavy_minus_sign: | The account code of the account | 1100 | | `title` | *Optional[str]* | :heavy_minus_sign: | The name of the account. | Current assets | -| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | \ No newline at end of file +| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | +| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | +| `records` | *Any* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragedrivegroupsaddrequest.md b/docs/models/filestoragedrivegroupsaddrequest.md index d17febef..2493fdbc 100644 --- a/docs/models/filestoragedrivegroupsaddrequest.md +++ b/docs/models/filestoragedrivegroupsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `drive_group` | [models.DriveGroupInput](../models/drivegroupinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `drive_group` | [models.DriveGroupInput](../models/drivegroupinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragedrivegroupsupdaterequest.md b/docs/models/filestoragedrivegroupsupdaterequest.md index eaf70d57..3f88e5c6 100644 --- a/docs/models/filestoragedrivegroupsupdaterequest.md +++ b/docs/models/filestoragedrivegroupsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `drive_group` | [models.DriveGroupInput](../models/drivegroupinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `drive_group` | [models.DriveGroupInput](../models/drivegroupinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragedrivesaddrequest.md b/docs/models/filestoragedrivesaddrequest.md index 973a8d75..ee860ac0 100644 --- a/docs/models/filestoragedrivesaddrequest.md +++ b/docs/models/filestoragedrivesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `drive` | [models.DriveInput](../models/driveinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `drive` | [models.DriveInput](../models/driveinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragedrivesupdaterequest.md b/docs/models/filestoragedrivesupdaterequest.md index 920d6bb7..c4cf3cd0 100644 --- a/docs/models/filestoragedrivesupdaterequest.md +++ b/docs/models/filestoragedrivesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `drive` | [models.DriveInput](../models/driveinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `drive` | [models.DriveInput](../models/driveinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragefilesexportrequest.md b/docs/models/filestoragefilesexportrequest.md index ba80a545..fcede2d3 100644 --- a/docs/models/filestoragefilesexportrequest.md +++ b/docs/models/filestoragefilesexportrequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `file_format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file +| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | +| `file_format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | \ No newline at end of file diff --git a/docs/models/filestoragefilessearchrequest.md b/docs/models/filestoragefilessearchrequest.md index b9bf9eba..d8ca347d 100644 --- a/docs/models/filestoragefilessearchrequest.md +++ b/docs/models/filestoragefilessearchrequest.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `files_search` | [models.FilesSearch](../models/filessearch.md) | :heavy_check_mark: | N/A | {
"query": "logo jpg"
} | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | @@ -14,4 +13,5 @@ | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | -| `filter_` | [Optional[models.FilesFilter]](../models/filesfilter.md) | :heavy_minus_sign: | Apply filters | | \ No newline at end of file +| `filter_` | [Optional[models.FilesFilter]](../models/filesfilter.md) | :heavy_minus_sign: | Apply filters | | +| `files_search` | [models.FilesSearch](../models/filessearch.md) | :heavy_check_mark: | N/A | {
"query": "logo jpg"
} | \ No newline at end of file diff --git a/docs/models/filestoragefilesupdaterequest.md b/docs/models/filestoragefilesupdaterequest.md index aa0d0da8..0ce9e912 100644 --- a/docs/models/filestoragefilesupdaterequest.md +++ b/docs/models/filestoragefilesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `update_file_request` | [models.UpdateFileRequest](../models/updatefilerequest.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `update_file_request` | [models.UpdateFileRequest](../models/updatefilerequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragefoldersaddrequest.md b/docs/models/filestoragefoldersaddrequest.md index df4f0324..7830e00a 100644 --- a/docs/models/filestoragefoldersaddrequest.md +++ b/docs/models/filestoragefoldersaddrequest.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `create_folder_request` | [models.CreateFolderRequest](../models/createfolderrequest.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file +| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | +| `create_folder_request` | [models.CreateFolderRequest](../models/createfolderrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragefolderscopyrequest.md b/docs/models/filestoragefolderscopyrequest.md index 2fbb3c4f..7b2d5f2e 100644 --- a/docs/models/filestoragefolderscopyrequest.md +++ b/docs/models/filestoragefolderscopyrequest.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `copy_folder_request` | [models.CopyFolderRequest](../models/copyfolderrequest.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | -| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file +| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | +| `copy_folder_request` | [models.CopyFolderRequest](../models/copyfolderrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragefoldersupdaterequest.md b/docs/models/filestoragefoldersupdaterequest.md index 26f2b019..735ce44b 100644 --- a/docs/models/filestoragefoldersupdaterequest.md +++ b/docs/models/filestoragefoldersupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `update_folder_request` | [models.UpdateFolderRequest](../models/updatefolderrequest.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `update_folder_request` | [models.UpdateFolderRequest](../models/updatefolderrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragesharedlinksaddrequest.md b/docs/models/filestoragesharedlinksaddrequest.md index aed06087..6b4b96f9 100644 --- a/docs/models/filestoragesharedlinksaddrequest.md +++ b/docs/models/filestoragesharedlinksaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `shared_link` | [models.SharedLinkInput](../models/sharedlinkinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `shared_link` | [models.SharedLinkInput](../models/sharedlinkinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestoragesharedlinksupdaterequest.md b/docs/models/filestoragesharedlinksupdaterequest.md index 9da237c9..e58a751e 100644 --- a/docs/models/filestoragesharedlinksupdaterequest.md +++ b/docs/models/filestoragesharedlinksupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `shared_link` | [models.SharedLinkInput](../models/sharedlinkinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `shared_link` | [models.SharedLinkInput](../models/sharedlinkinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestorageuploadsessionsaddrequest.md b/docs/models/filestorageuploadsessionsaddrequest.md index 72a87261..da14bdf6 100644 --- a/docs/models/filestorageuploadsessionsaddrequest.md +++ b/docs/models/filestorageuploadsessionsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `create_upload_session_request` | [models.CreateUploadSessionRequest](../models/createuploadsessionrequest.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `create_upload_session_request` | [models.CreateUploadSessionRequest](../models/createuploadsessionrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filestorageuploadsessionsuploadrequest.md b/docs/models/filestorageuploadsessionsuploadrequest.md index 8c2cb2db..f227e4fa 100644 --- a/docs/models/filestorageuploadsessionsuploadrequest.md +++ b/docs/models/filestorageuploadsessionsuploadrequest.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `part_number` | *float* | :heavy_check_mark: | Part number of the file part being uploaded. | 0 | -| `request_body` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `part_number` | *float* | :heavy_check_mark: | Part number of the file part being uploaded. | 0 | | `digest` | *Optional[str]* | :heavy_minus_sign: | The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest) | sha=fpRyg5eVQletdZqEKaFlqwBXJzM= | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `request_body` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/folder.md b/docs/models/folder.md index 3d7732c7..5e86bd39 100644 --- a/docs/models/folder.md +++ b/docs/models/folder.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | The name of the folder | Documents | -| `parent_folders` | List[[models.LinkedFolder](../models/linkedfolder.md)] | :heavy_check_mark: | The parent folders of the file, starting from the root | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | +| `name` | *str* | :heavy_check_mark: | The name of the folder | Documents | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional description of the folder | My Personal Documents | | `path` | *OptionalNullable[str]* | :heavy_minus_sign: | The full path of the folder (includes the folder name) | /Personal/Documents | | `size` | *OptionalNullable[int]* | :heavy_minus_sign: | The size of the folder in bytes | 1810673 | | `owner` | [Optional[models.Owner]](../models/owner.md) | :heavy_minus_sign: | N/A | | +| `parent_folders` | List[[models.LinkedFolder](../models/linkedfolder.md)] | :heavy_check_mark: | The parent folders of the file, starting from the root | | | `parent_folders_complete` | *Optional[bool]* | :heavy_minus_sign: | Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder | | | `custom_mappings` | [OptionalNullable[models.CustomMappings]](../models/custommappings.md) | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | | `updated_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who last updated the object. | 12345 | diff --git a/docs/models/formfieldoptiongroup.md b/docs/models/formfieldoptiongroup.md index 0b32c0d4..86ed8b07 100644 --- a/docs/models/formfieldoptiongroup.md +++ b/docs/models/formfieldoptiongroup.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | 1234 | | `label` | *str* | :heavy_check_mark: | N/A | General Channel | | `options` | List[[models.SimpleFormFieldOption](../models/simpleformfieldoption.md)] | :heavy_check_mark: | N/A | | -| `option_type` | [models.FormFieldOptionGroupOptionType](../models/formfieldoptiongroupoptiontype.md) | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | 1234 | \ No newline at end of file +| `option_type` | [models.FormFieldOptionGroupOptionType](../models/formfieldoptiongroupoptiontype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hriscompaniesaddrequest.md b/docs/models/hriscompaniesaddrequest.md index 6061def9..90647a6c 100644 --- a/docs/models/hriscompaniesaddrequest.md +++ b/docs/models/hriscompaniesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `hris_company` | [models.HrisCompanyInput](../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `hris_company` | [models.HrisCompanyInput](../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hriscompaniesupdaterequest.md b/docs/models/hriscompaniesupdaterequest.md index f59e5102..0c0caaa4 100644 --- a/docs/models/hriscompaniesupdaterequest.md +++ b/docs/models/hriscompaniesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `hris_company` | [models.HrisCompanyInput](../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `hris_company` | [models.HrisCompanyInput](../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hriscompany.md b/docs/models/hriscompany.md index 84550d9f..defd7eab 100644 --- a/docs/models/hriscompany.md +++ b/docs/models/hriscompany.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `legal_name` | *Nullable[str]* | :heavy_check_mark: | N/A | SpaceX | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | +| `legal_name` | *Nullable[str]* | :heavy_check_mark: | N/A | SpaceX | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | SpaceX | | `subdomain` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | company | | `status` | [Optional[models.HrisCompanyStatus]](../models/hriscompanystatus.md) | :heavy_minus_sign: | N/A | active | diff --git a/docs/models/hrisdepartmentsaddrequest.md b/docs/models/hrisdepartmentsaddrequest.md index 94ef7b20..e86e0573 100644 --- a/docs/models/hrisdepartmentsaddrequest.md +++ b/docs/models/hrisdepartmentsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `department` | [models.DepartmentInput](../models/departmentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `department` | [models.DepartmentInput](../models/departmentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hrisdepartmentsupdaterequest.md b/docs/models/hrisdepartmentsupdaterequest.md index c1772a59..afaaa8c1 100644 --- a/docs/models/hrisdepartmentsupdaterequest.md +++ b/docs/models/hrisdepartmentsupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `department` | [models.DepartmentInput](../models/departmentinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `department` | [models.DepartmentInput](../models/departmentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hrisemployeesaddrequest.md b/docs/models/hrisemployeesaddrequest.md index 7c77b1eb..475cc3ec 100644 --- a/docs/models/hrisemployeesaddrequest.md +++ b/docs/models/hrisemployeesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `employee` | [models.EmployeeInput](../models/employeeinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `employee` | [models.EmployeeInput](../models/employeeinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hrisemployeesupdaterequest.md b/docs/models/hrisemployeesupdaterequest.md index cbb58689..cf828461 100644 --- a/docs/models/hrisemployeesupdaterequest.md +++ b/docs/models/hrisemployeesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `employee` | [models.EmployeeInput](../models/employeeinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `employee` | [models.EmployeeInput](../models/employeeinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsaddrequest.md b/docs/models/hristimeoffrequestsaddrequest.md index b59f0737..15c6eb66 100644 --- a/docs/models/hristimeoffrequestsaddrequest.md +++ b/docs/models/hristimeoffrequestsaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `time_off_request` | [models.TimeOffRequestInput](../models/timeoffrequestinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `time_off_request` | [models.TimeOffRequestInput](../models/timeoffrequestinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsdeleterequest.md b/docs/models/hristimeoffrequestsdeleterequest.md index 2c45fc3c..20b50201 100644 --- a/docs/models/hristimeoffrequestsdeleterequest.md +++ b/docs/models/hristimeoffrequestsdeleterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsonerequest.md b/docs/models/hristimeoffrequestsonerequest.md index 70d49da9..abae50ca 100644 --- a/docs/models/hristimeoffrequestsonerequest.md +++ b/docs/models/hristimeoffrequestsonerequest.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | -| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file +| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | +| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsupdaterequest.md b/docs/models/hristimeoffrequestsupdaterequest.md index 4a94875a..e15027fd 100644 --- a/docs/models/hristimeoffrequestsupdaterequest.md +++ b/docs/models/hristimeoffrequestsupdaterequest.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `employee_id_param` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | -| `time_off_request` | [models.TimeOffRequestInput](../models/timeoffrequestinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `employee_id_param` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | +| `time_off_request` | [models.TimeOffRequestInput](../models/timeoffrequestinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/income.md b/docs/models/income.md index d1eff656..43611ef6 100644 --- a/docs/models/income.md +++ b/docs/models/income.md @@ -7,9 +7,9 @@ The operating income accounts | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | -| `records` | *Any* | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `code` | *Optional[str]* | :heavy_minus_sign: | The account code of the account | 1100 | | `title` | *Optional[str]* | :heavy_minus_sign: | The name of the account. | Current assets | -| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | \ No newline at end of file +| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | +| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | +| `records` | *Any* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketcommentsaddrequest.md b/docs/models/issuetrackingcollectionticketcommentsaddrequest.md index 33ec18b5..b7bd16d9 100644 --- a/docs/models/issuetrackingcollectionticketcommentsaddrequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsaddrequest.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | -| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | -| `collection_ticket_comment` | [models.CollectionTicketCommentInput](../models/collectionticketcommentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | +| `collection_ticket_comment` | [models.CollectionTicketCommentInput](../models/collectionticketcommentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketcommentsallrequest.md b/docs/models/issuetrackingcollectionticketcommentsallrequest.md index b0a182df..c9820944 100644 --- a/docs/models/issuetrackingcollectionticketcommentsallrequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsallrequest.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | -| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `sort` | [Optional[models.CommentsSort]](../models/commentssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md b/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md index 4d78b0e3..b67c0aae 100644 --- a/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | -| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketcommentsonerequest.md b/docs/models/issuetrackingcollectionticketcommentsonerequest.md index 03336bb4..f0041d9f 100644 --- a/docs/models/issuetrackingcollectionticketcommentsonerequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsonerequest.md @@ -6,12 +6,12 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | -| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md b/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md index c8f56fa5..b4a035ad 100644 --- a/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | -| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | -| `collection_ticket_comment` | [models.CollectionTicketCommentInput](../models/collectionticketcommentinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | +| `collection_ticket_comment` | [models.CollectionTicketCommentInput](../models/collectionticketcommentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsaddrequest.md b/docs/models/issuetrackingcollectionticketsaddrequest.md index 0a0a6b8c..fbabfaf8 100644 --- a/docs/models/issuetrackingcollectionticketsaddrequest.md +++ b/docs/models/issuetrackingcollectionticketsaddrequest.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | -| `ticket` | [models.TicketInput](../models/ticketinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `ticket` | [models.TicketInput](../models/ticketinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsallrequest.md b/docs/models/issuetrackingcollectionticketsallrequest.md index fafba79b..4e23c2d4 100644 --- a/docs/models/issuetrackingcollectionticketsallrequest.md +++ b/docs/models/issuetrackingcollectionticketsallrequest.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `sort` | [Optional[models.TicketsSort]](../models/ticketssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} | | `filter_` | [Optional[models.IssuesFilter]](../models/issuesfilter.md) | :heavy_minus_sign: | Apply filters | {
"status": [
"open"
]
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/models/issuetrackingcollectionticketsdeleterequest.md b/docs/models/issuetrackingcollectionticketsdeleterequest.md index f2c39c71..caddb095 100644 --- a/docs/models/issuetrackingcollectionticketsdeleterequest.md +++ b/docs/models/issuetrackingcollectionticketsdeleterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsonerequest.md b/docs/models/issuetrackingcollectionticketsonerequest.md index c5afad12..2e511d57 100644 --- a/docs/models/issuetrackingcollectionticketsonerequest.md +++ b/docs/models/issuetrackingcollectionticketsonerequest.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsupdaterequest.md b/docs/models/issuetrackingcollectionticketsupdaterequest.md index ca708d02..bf8eea7b 100644 --- a/docs/models/issuetrackingcollectionticketsupdaterequest.md +++ b/docs/models/issuetrackingcollectionticketsupdaterequest.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | -| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | -| `ticket` | [models.TicketInput](../models/ticketinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `ticket` | [models.TicketInput](../models/ticketinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/journalentrylineitem.md b/docs/models/journalentrylineitem.md index 67a767c8..5190cc4e 100644 --- a/docs/models/journalentrylineitem.md +++ b/docs/models/journalentrylineitem.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `type` | [models.JournalEntryLineItemType](../models/journalentrylineitemtype.md) | :heavy_check_mark: | Debit entries are considered positive, and credit entries are considered negative. | debit | -| `ledger_account` | [Nullable[models.LinkedLedgerAccount]](../models/linkedledgeraccount.md) | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | User defined description | Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection. | | `tax_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Tax amount | 27500 | | `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 | | `total_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Debit entries are considered positive, and credit entries are considered negative. | 27500 | +| `type` | [models.JournalEntryLineItemType](../models/journalentrylineitemtype.md) | :heavy_check_mark: | Debit entries are considered positive, and credit entries are considered negative. | debit | | `tax_rate` | [Optional[models.LinkedTaxRate]](../models/linkedtaxrate.md) | :heavy_minus_sign: | N/A | | | ~~`tracking_category`~~ | [OptionalNullable[models.DeprecatedLinkedTrackingCategory]](../models/deprecatedlinkedtrackingcategory.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | +| `ledger_account` | [Nullable[models.LinkedLedgerAccount]](../models/linkedledgeraccount.md) | :heavy_check_mark: | N/A | | | `customer` | [OptionalNullable[models.LinkedCustomer]](../models/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `supplier` | [OptionalNullable[models.LinkedSupplier]](../models/linkedsupplier.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | diff --git a/docs/models/journalentrylineiteminput.md b/docs/models/journalentrylineiteminput.md index f83d8490..946df596 100644 --- a/docs/models/journalentrylineiteminput.md +++ b/docs/models/journalentrylineiteminput.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `type` | [models.JournalEntryLineItemType](../models/journalentrylineitemtype.md) | :heavy_check_mark: | Debit entries are considered positive, and credit entries are considered negative. | debit | -| `ledger_account` | [Nullable[models.LinkedLedgerAccountInput]](../models/linkedledgeraccountinput.md) | :heavy_check_mark: | N/A | | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | User defined description | Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection. | | `tax_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Tax amount | 27500 | | `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 | | `total_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Debit entries are considered positive, and credit entries are considered negative. | 27500 | +| `type` | [models.JournalEntryLineItemType](../models/journalentrylineitemtype.md) | :heavy_check_mark: | Debit entries are considered positive, and credit entries are considered negative. | debit | | `tax_rate` | [Optional[models.LinkedTaxRateInput]](../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | | | ~~`tracking_category`~~ | [OptionalNullable[models.DeprecatedLinkedTrackingCategory]](../models/deprecatedlinkedtrackingcategory.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | +| `ledger_account` | [Nullable[models.LinkedLedgerAccountInput]](../models/linkedledgeraccountinput.md) | :heavy_check_mark: | N/A | | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | diff --git a/docs/models/lead.md b/docs/models/lead.md index 1cacc59f..e93f716a 100644 --- a/docs/models/lead.md +++ b/docs/models/lead.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the contact. | 12345 | | `name` | *str* | :heavy_check_mark: | Full name of the lead. | Elon Musk | | `company_name` | *Nullable[str]* | :heavy_check_mark: | The name of the company the lead is associated with. | Spacex | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the contact. | 12345 | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the lead. | 54321 | | `owner_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the owner of the lead. | John Doe | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company the lead is associated with. | 2 | diff --git a/docs/models/log.md b/docs/models/log.md index f6a86d1c..bc0d756b 100644 --- a/docs/models/log.md +++ b/docs/models/log.md @@ -10,6 +10,7 @@ | `child_request` | *bool* | :heavy_check_mark: | Indicates whether or not this is a child or parent request. | false | | `consumer_id` | *str* | :heavy_check_mark: | The consumer Id associated with the request. | test-consumer | | `duration` | *float* | :heavy_check_mark: | The entire execution time in milliseconds it took to call the Apideck service provider. | 2220.379304 | +| `error_message` | *OptionalNullable[str]* | :heavy_minus_sign: | If error occurred, this is brief explanation | Refresh token is invalid | | `execution` | *int* | :heavy_check_mark: | The entire execution time in milliseconds it took to make the request. | 2248 | | `has_children` | *bool* | :heavy_check_mark: | When request is a parent request, this indicates if there are child requests associated. | false | | `http_method` | *str* | :heavy_check_mark: | HTTP Method of request. | GET | @@ -20,9 +21,8 @@ | `path` | *str* | :heavy_check_mark: | The path component of the URI the request was made to. | /vault/connections | | `sandbox` | *bool* | :heavy_check_mark: | Indicates whether the request was made using Apidecks sandbox credentials or not. | false | | `service` | [models.Service](../models/service.md) | :heavy_check_mark: | Apideck service provider associated with request. | | +| `source_ip` | *OptionalNullable[str]* | :heavy_minus_sign: | The IP address of the source of the request. | 94.227.131.238 | | `status_code` | *int* | :heavy_check_mark: | HTTP Status code that was returned. | 200 | | `success` | *bool* | :heavy_check_mark: | Whether or not the request was successful. | true | | `timestamp` | *str* | :heavy_check_mark: | ISO Date and time when the request was made. | 2021-07-12T14:26:17.420Z | -| `unified_api` | [models.UnifiedAPI](../models/unifiedapi.md) | :heavy_check_mark: | Which Unified Api request was made to. | vault | -| `error_message` | *OptionalNullable[str]* | :heavy_minus_sign: | If error occurred, this is brief explanation | Refresh token is invalid | -| `source_ip` | *OptionalNullable[str]* | :heavy_minus_sign: | The IP address of the source of the request. | 94.227.131.238 | \ No newline at end of file +| `unified_api` | [models.UnifiedAPI](../models/unifiedapi.md) | :heavy_check_mark: | Which Unified Api request was made to. | vault | \ No newline at end of file diff --git a/docs/models/message.md b/docs/models/message.md index 9591cd04..75646b7f 100644 --- a/docs/models/message.md +++ b/docs/models/message.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `from_` | *str* | :heavy_check_mark: | The phone number that initiated the message. | +15017122661 | | `to` | *str* | :heavy_check_mark: | The phone number that received the message. | +15017122662 | -| `body` | *str* | :heavy_check_mark: | The message text. | Hi! How are you doing? | -| `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | Picture | +| `body` | *str* | :heavy_check_mark: | The message text. | Hi! How are you doing? | | `type` | [Optional[models.MessageType]](../models/messagetype.md) | :heavy_minus_sign: | Set to sms for SMS messages and mms for MMS messages. | sms | | `number_of_units` | *Optional[int]* | :heavy_minus_sign: | The number of units that make up the complete message. Messages can be split up due to the constraints of the message size. | 1 | | `number_of_media_files` | *Optional[int]* | :heavy_minus_sign: | The number of media files associated with the message. | 1 | diff --git a/docs/models/messageinput.md b/docs/models/messageinput.md index 65852a48..8c37ad9c 100644 --- a/docs/models/messageinput.md +++ b/docs/models/messageinput.md @@ -7,8 +7,8 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `from_` | *str* | :heavy_check_mark: | The phone number that initiated the message. | +15017122661 | | `to` | *str* | :heavy_check_mark: | The phone number that received the message. | +15017122662 | -| `body` | *str* | :heavy_check_mark: | The message text. | Hi! How are you doing? | | `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | Picture | +| `body` | *str* | :heavy_check_mark: | The message text. | Hi! How are you doing? | | `type` | [Optional[models.MessageType]](../models/messagetype.md) | :heavy_minus_sign: | Set to sms for SMS messages and mms for MMS messages. | sms | | `scheduled_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The scheduled date and time of the message. | 2020-09-30T07:43:32.000Z | | `webhook_url` | *Optional[str]* | :heavy_minus_sign: | Define a webhook to receive delivery notifications. | https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms | diff --git a/docs/models/opportunity.md b/docs/models/opportunity.md index c360a037..4a16d787 100644 --- a/docs/models/opportunity.md +++ b/docs/models/opportunity.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `title` | *str* | :heavy_check_mark: | The title or name of the opportunity. | New Rocket | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for the opportunity. | 12345 | +| `title` | *str* | :heavy_check_mark: | The title or name of the opportunity. | New Rocket | | `primary_contact_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of the primary contact associated with the opportunity. | 12345 | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the opportunity. | Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. | | `type` | *OptionalNullable[str]* | :heavy_minus_sign: | The type of the opportunity | Existing Customer - Upgrade | diff --git a/docs/models/otherexpenses.md b/docs/models/otherexpenses.md index dd8e4175..49093b71 100644 --- a/docs/models/otherexpenses.md +++ b/docs/models/otherexpenses.md @@ -7,9 +7,9 @@ The other expenses accounts | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | -| `records` | *Any* | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `code` | *Optional[str]* | :heavy_minus_sign: | The account code of the account | 1100 | | `title` | *Optional[str]* | :heavy_minus_sign: | The name of the account. | Current assets | -| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | \ No newline at end of file +| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | +| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | +| `records` | *Any* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/otherincome.md b/docs/models/otherincome.md index 2302f06d..49ca5646 100644 --- a/docs/models/otherincome.md +++ b/docs/models/otherincome.md @@ -7,9 +7,9 @@ The other income accounts | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | -| `records` | *Any* | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `code` | *Optional[str]* | :heavy_minus_sign: | The account code of the account | 1100 | | `title` | *Optional[str]* | :heavy_minus_sign: | The name of the account. | Current assets | -| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | \ No newline at end of file +| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | +| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | +| `records` | *Any* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/payment.md b/docs/models/payment.md index f8fa5535..da30313d 100644 --- a/docs/models/payment.md +++ b/docs/models/payment.md @@ -6,11 +6,10 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | A unique identifier for an object. | 12345 | -| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | -| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `downstream_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | | `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | +| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional transaction reference message ie: Debit remittance detail. | 123456 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `payment_method_reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message returned by payment method on processing | 123456 | @@ -18,6 +17,7 @@ | ~~`accounts_receivable_account_type`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Type of accounts receivable account. | Account | | ~~`accounts_receivable_account_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the account to allocate payment to. | 123456 | | `account` | [OptionalNullable[models.LinkedLedgerAccount]](../models/linkedledgeraccount.md) | :heavy_minus_sign: | N/A | | +| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `customer` | [OptionalNullable[models.LinkedCustomer]](../models/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | ~~`supplier`~~ | [OptionalNullable[models.DeprecatedLinkedSupplier]](../models/deprecatedlinkedsupplier.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The supplier this entity is linked to. | | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | diff --git a/docs/models/paymentinput.md b/docs/models/paymentinput.md index 9b4b0c74..c31de53d 100644 --- a/docs/models/paymentinput.md +++ b/docs/models/paymentinput.md @@ -5,10 +5,9 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | -| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | +| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction or record | 49.99 | | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional transaction reference message ie: Debit remittance detail. | 123456 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `payment_method_reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message returned by payment method on processing | 123456 | @@ -16,6 +15,7 @@ | ~~`accounts_receivable_account_type`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Type of accounts receivable account. | Account | | ~~`accounts_receivable_account_id`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the account to allocate payment to. | 123456 | | `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | +| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | ~~`supplier`~~ | [OptionalNullable[models.DeprecatedLinkedSupplierInput]](../models/deprecatedlinkedsupplierinput.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The supplier this entity is linked to. | | | `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | diff --git a/docs/models/payroll.md b/docs/models/payroll.md index 0a9153f0..1a910bfc 100644 --- a/docs/models/payroll.md +++ b/docs/models/payroll.md @@ -6,12 +6,12 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `id` | *Nullable[str]* | :heavy_check_mark: | A unique identifier for an object. | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of the company. | 23456 | | `processed` | *Nullable[bool]* | :heavy_check_mark: | Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. | false | +| `processed_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date the payroll was processed. | 2022-04-08 | | `check_date` | *Nullable[str]* | :heavy_check_mark: | The date on which employees will be paid for the payroll. | 2022-04-08 | | `start_date` | *Nullable[str]* | :heavy_check_mark: | The start date, inclusive, of the pay period. | 2022-04-08 | | `end_date` | *Nullable[str]* | :heavy_check_mark: | The end date, inclusive, of the pay period. | 2022-04-21 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of the company. | 23456 | -| `processed_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date the payroll was processed. | 2022-04-08 | | `totals` | [Optional[models.PayrollTotals]](../models/payrolltotals.md) | :heavy_minus_sign: | The overview of the payroll totals. | | | `compensations` | List[[models.Compensation](../models/compensation.md)] | :heavy_minus_sign: | An array of compensations for the payroll. | | | `custom_mappings` | [OptionalNullable[models.CustomMappings]](../models/custommappings.md) | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | \ No newline at end of file diff --git a/docs/models/phonenumber.md b/docs/models/phonenumber.md index 75c652cb..d26aa670 100644 --- a/docs/models/phonenumber.md +++ b/docs/models/phonenumber.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `number` | *str* | :heavy_check_mark: | The phone number | 111-111-1111 | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the phone number | 12345 | | `country_code` | *OptionalNullable[str]* | :heavy_minus_sign: | The country code of the phone number, e.g. +1 | 1 | | `area_code` | *OptionalNullable[str]* | :heavy_minus_sign: | The area code of the phone number, e.g. 323 | 323 | +| `number` | *str* | :heavy_check_mark: | The phone number | 111-111-1111 | | `extension` | *OptionalNullable[str]* | :heavy_minus_sign: | The extension of the phone number | 105 | | `type` | [OptionalNullable[models.PhoneNumberType]](../models/phonenumbertype.md) | :heavy_minus_sign: | The type of phone number | primary | \ No newline at end of file diff --git a/docs/models/pipeline.md b/docs/models/pipeline.md index 078f5227..bc7ea31b 100644 --- a/docs/models/pipeline.md +++ b/docs/models/pipeline.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | The name of the Pipeline. | Sales Pipeline | | `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier of the Pipeline. | default | +| `name` | *str* | :heavy_check_mark: | The name of the Pipeline. | Sales Pipeline | | `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the Pipeline is archived or not. | false | | `active` | *Optional[bool]* | :heavy_minus_sign: | Whether the Pipeline is active or not. | false | diff --git a/docs/models/pipelineinput.md b/docs/models/pipelineinput.md index 563ec368..080b9e12 100644 --- a/docs/models/pipelineinput.md +++ b/docs/models/pipelineinput.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | The name of the Pipeline. | Sales Pipeline | | `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier of the Pipeline. | default | +| `name` | *str* | :heavy_check_mark: | The name of the Pipeline. | Sales Pipeline | | `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `archived` | *Optional[bool]* | :heavy_minus_sign: | Whether the Pipeline is archived or not. | false | | `active` | *Optional[bool]* | :heavy_minus_sign: | Whether the Pipeline is active or not. | false | diff --git a/docs/models/profitandloss.md b/docs/models/profitandloss.md index 9498b5d7..43597c49 100644 --- a/docs/models/profitandloss.md +++ b/docs/models/profitandloss.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `report_name` | *str* | :heavy_check_mark: | The name of the report | ProfitAndLoss | -| `currency` | [Nullable[models.Currency]](../models/currency.md) | :heavy_check_mark: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | -| `income` | [models.Income](../models/income.md) | :heavy_check_mark: | The operating income accounts | {
"id": "123",
"code": "123",
"title": "Operating Income",
"type": "Section",
"total": 60000,
"records": [
{
"id": "137",
"title": "Sales of products",
"code": "137",
"type": "Section",
"total": 20000,
"records": [
{
"id": "13701",
"title": "Sales of products",
"code": "13701",
"type": "Record",
"total": 20000
}
]
},
{
"id": "138",
"title": "Sales of services",
"code": "138",
"type": "Section",
"total": 40000,
"records": [
{
"id": "789",
"code": "789",
"title": "Sales of External Services",
"type": "Record",
"total": 10000
},
{
"id": "101",
"code": "101",
"title": "Sales of Internal Services",
"type": "Record",
"total": 30000
}
]
}
]
} | -| `expenses` | [models.ExpensesModel](../models/expensesmodel.md) | :heavy_check_mark: | The operating expenses accounts | {
"id": "123",
"code": "123",
"title": "Operating Expenses",
"type": "Section",
"total": 14000,
"records": [
{
"id": "137",
"title": "Maintenance",
"code": "137",
"type": "Record",
"total": 1000
},
{
"id": "138",
"title": "Rent",
"code": "138",
"type": "Record",
"total": 10000
},
{
"id": "789",
"code": "789",
"title": "Utilities",
"type": "Section",
"total": 3000,
"records": [
{
"id": "101",
"code": "101",
"title": "Electricity",
"type": "Record",
"total": 2000
},
{
"id": "102",
"code": "102",
"title": "Telephone",
"type": "Record",
"total": 1000
}
]
}
]
} | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | +| `report_name` | *str* | :heavy_check_mark: | The name of the report | ProfitAndLoss | | `start_date` | *Optional[str]* | :heavy_minus_sign: | The start date of the report | 2017-01-01 | | `end_date` | *Optional[str]* | :heavy_minus_sign: | The end date of the report | 2017-01-31 | +| `currency` | [Nullable[models.Currency]](../models/currency.md) | :heavy_check_mark: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | +| `income` | [models.Income](../models/income.md) | :heavy_check_mark: | The operating income accounts | {
"id": "123",
"code": "123",
"title": "Operating Income",
"type": "Section",
"total": 60000,
"records": [
{
"id": "137",
"title": "Sales of products",
"code": "137",
"type": "Section",
"total": 20000,
"records": [
{
"id": "13701",
"title": "Sales of products",
"code": "13701",
"type": "Record",
"total": 20000
}
]
},
{
"id": "138",
"title": "Sales of services",
"code": "138",
"type": "Section",
"total": 40000,
"records": [
{
"id": "789",
"code": "789",
"title": "Sales of External Services",
"type": "Record",
"total": 10000
},
{
"id": "101",
"code": "101",
"title": "Sales of Internal Services",
"type": "Record",
"total": 30000
}
]
}
]
} | | `cost_of_goods_sold` | [Optional[models.CostOfGoodsSold]](../models/costofgoodssold.md) | :heavy_minus_sign: | The cost of goods sold accounts | {
"id": "123",
"code": "123",
"title": "Cost of Goods Sold",
"type": "Section",
"total": 12000,
"records": [
{
"id": "123",
"code": "123",
"title": "COGS Sales",
"type": "Record",
"total": 12000
}
]
} | +| `expenses` | [models.ExpensesModel](../models/expensesmodel.md) | :heavy_check_mark: | The operating expenses accounts | {
"id": "123",
"code": "123",
"title": "Operating Expenses",
"type": "Section",
"total": 14000,
"records": [
{
"id": "137",
"title": "Maintenance",
"code": "137",
"type": "Record",
"total": 1000
},
{
"id": "138",
"title": "Rent",
"code": "138",
"type": "Record",
"total": 10000
},
{
"id": "789",
"code": "789",
"title": "Utilities",
"type": "Section",
"total": 3000,
"records": [
{
"id": "101",
"code": "101",
"title": "Electricity",
"type": "Record",
"total": 2000
},
{
"id": "102",
"code": "102",
"title": "Telephone",
"type": "Record",
"total": 1000
}
]
}
]
} | | `other_income` | [Optional[models.OtherIncome]](../models/otherincome.md) | :heavy_minus_sign: | The other income accounts | {
"id": "123",
"code": "123",
"title": "Other Income",
"type": "Section",
"total": 3000,
"records": [
{
"id": "123",
"code": "123",
"title": "Interest Income",
"type": "Record",
"total": 2000
},
{
"id": "123",
"code": "123",
"title": "Foreign Exchange Gain",
"type": "Record",
"total": 1000
}
]
} | | `other_expenses` | [Optional[models.OtherExpenses]](../models/otherexpenses.md) | :heavy_minus_sign: | The other expenses accounts | {
"id": "123",
"code": "123",
"title": "Other Expenses",
"type": "Section",
"total": 1000,
"records": [
{
"id": "123",
"code": "123",
"title": "Unrealized Gain/Loss",
"type": "Record",
"total": 1000
}
]
} | | `uncategorized_accounts` | [Optional[models.UncategorizedAccounts]](../models/uncategorizedaccounts.md) | :heavy_minus_sign: | The accounts not categorized in the other sections | {
"id": "123",
"code": "123",
"title": "Uncategorized Accounts",
"type": "Section",
"total": 0,
"records": [
{
"id": "123",
"code": "123",
"title": "Elimination Adjustments",
"type": "Record",
"total": 0
}
]
} | diff --git a/docs/models/reports.md b/docs/models/reports.md index 080bd544..01f19730 100644 --- a/docs/models/reports.md +++ b/docs/models/reports.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `end_date` | *str* | :heavy_check_mark: | The start date of the report | 2017-01-31 | -| `assets` | [models.BalanceSheetAssetsAccount](../models/balancesheetassetsaccount.md) | :heavy_check_mark: | A balance sheet assets account represents the financial position of a company at a specific point in time. | {
"account_id": "1",
"code": "1000",
"name": "Assets",
"value": 50000,
"items": [
{
"account_id": "101",
"code": "1100",
"name": "Current Assets",
"value": 20000,
"items": [
{
"account_id": "1011",
"code": "1101",
"name": "Cash and Cash Equivalents",
"value": 10000
},
{
"account_id": "1012",
"code": "1102",
"name": "Accounts Receivable",
"value": 5000
},
{
"account_id": "1013",
"code": "1103",
"name": "Inventory",
"value": 3000
},
{
"account_id": "1014",
"code": "1104",
"name": "Prepaid Expenses",
"value": 2000
}
]
},
{
"account_id": "102",
"code": "1200",
"name": "Non-Current Assets",
"value": 30000,
"items": [
{
"account_id": "1021",
"code": "1201",
"name": "Property, Plant, and Equipment (PPE)",
"value": 25000
},
{
"account_id": "1022",
"code": "1202",
"name": "Intangible Assets",
"value": 5000,
"items": [
{
"account_id": "10221",
"code": "1203",
"name": "Goodwill",
"value": 3000
},
{
"account_id": "10222",
"code": "1204",
"name": "Patents",
"value": 2000
}
]
}
]
}
]
} | -| `liabilities` | [models.BalanceSheetLiabilitiesAccount](../models/balancesheetliabilitiesaccount.md) | :heavy_check_mark: | A balance sheet liabilities account represents the financial position of a company at a specific point in time. | {
"account_id": "2",
"code": "2000",
"name": "Liabilities",
"value": 30000,
"items": [
{
"account_id": "201",
"code": "2100",
"name": "Current Liabilities",
"value": 10000,
"items": [
{
"account_id": "2011",
"code": "2101",
"name": "Accounts Payable",
"value": 4000
},
{
"account_id": "2012",
"code": "2102",
"name": "Short-Term Debt",
"value": 2000
},
{
"account_id": "2013",
"code": "2103",
"name": "Accrued Expenses",
"value": 1000
},
{
"account_id": "2014",
"code": "2104",
"name": "Current Portion of Long-Term Debt",
"value": 3000
}
]
},
{
"account_id": "202",
"code": "2200",
"name": "Non-Current Liabilities",
"value": 20000,
"items": [
{
"account_id": "2021",
"code": "2201",
"name": "Long-Term Debt",
"value": 15000
},
{
"account_id": "2022",
"code": "2202",
"name": "Deferred Tax Liabilities",
"value": 3000
},
{
"account_id": "2023",
"code": "2203",
"name": "Pension Liabilities",
"value": 2000
}
]
}
]
} | -| `equity` | [models.BalanceSheetEquityAccount](../models/balancesheetequityaccount.md) | :heavy_check_mark: | A balance sheet equity account represents the financial position of a company at a specific point in time. | {
"account_id": "3",
"code": "3000",
"name": "Equity",
"value": 20000,
"items": [
{
"account_id": "301",
"code": "3100",
"name": "Common Stock",
"value": 5000
},
{
"account_id": "302",
"code": "3200",
"name": "Retained Earnings",
"value": 10000
},
{
"account_id": "303",
"code": "3300",
"name": "Additional Paid-In Capital",
"value": 3000
},
{
"account_id": "304",
"code": "3400",
"name": "Treasury Stock",
"value": -1000
},
{
"account_id": "305",
"code": "3500",
"name": "Other Comprehensive Income",
"value": 3000
}
]
} | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `report_name` | *Optional[str]* | :heavy_minus_sign: | The name of the report | BalanceSheet | | `start_date` | *Optional[str]* | :heavy_minus_sign: | The start date of the report | 2017-01-01 | +| `end_date` | *str* | :heavy_check_mark: | The start date of the report | 2017-01-31 | | `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | +| `assets` | [models.BalanceSheetAssetsAccount](../models/balancesheetassetsaccount.md) | :heavy_check_mark: | A balance sheet assets account represents the financial position of a company at a specific point in time. | {
"account_id": "1",
"code": "1000",
"name": "Assets",
"value": 50000,
"items": [
{
"account_id": "101",
"code": "1100",
"name": "Current Assets",
"value": 20000,
"items": [
{
"account_id": "1011",
"code": "1101",
"name": "Cash and Cash Equivalents",
"value": 10000
},
{
"account_id": "1012",
"code": "1102",
"name": "Accounts Receivable",
"value": 5000
},
{
"account_id": "1013",
"code": "1103",
"name": "Inventory",
"value": 3000
},
{
"account_id": "1014",
"code": "1104",
"name": "Prepaid Expenses",
"value": 2000
}
]
},
{
"account_id": "102",
"code": "1200",
"name": "Non-Current Assets",
"value": 30000,
"items": [
{
"account_id": "1021",
"code": "1201",
"name": "Property, Plant, and Equipment (PPE)",
"value": 25000
},
{
"account_id": "1022",
"code": "1202",
"name": "Intangible Assets",
"value": 5000,
"items": [
{
"account_id": "10221",
"code": "1203",
"name": "Goodwill",
"value": 3000
},
{
"account_id": "10222",
"code": "1204",
"name": "Patents",
"value": 2000
}
]
}
]
}
]
} | +| `liabilities` | [models.BalanceSheetLiabilitiesAccount](../models/balancesheetliabilitiesaccount.md) | :heavy_check_mark: | A balance sheet liabilities account represents the financial position of a company at a specific point in time. | {
"account_id": "2",
"code": "2000",
"name": "Liabilities",
"value": 30000,
"items": [
{
"account_id": "201",
"code": "2100",
"name": "Current Liabilities",
"value": 10000,
"items": [
{
"account_id": "2011",
"code": "2101",
"name": "Accounts Payable",
"value": 4000
},
{
"account_id": "2012",
"code": "2102",
"name": "Short-Term Debt",
"value": 2000
},
{
"account_id": "2013",
"code": "2103",
"name": "Accrued Expenses",
"value": 1000
},
{
"account_id": "2014",
"code": "2104",
"name": "Current Portion of Long-Term Debt",
"value": 3000
}
]
},
{
"account_id": "202",
"code": "2200",
"name": "Non-Current Liabilities",
"value": 20000,
"items": [
{
"account_id": "2021",
"code": "2201",
"name": "Long-Term Debt",
"value": 15000
},
{
"account_id": "2022",
"code": "2202",
"name": "Deferred Tax Liabilities",
"value": 3000
},
{
"account_id": "2023",
"code": "2203",
"name": "Pension Liabilities",
"value": 2000
}
]
}
]
} | +| `equity` | [models.BalanceSheetEquityAccount](../models/balancesheetequityaccount.md) | :heavy_check_mark: | A balance sheet equity account represents the financial position of a company at a specific point in time. | {
"account_id": "3",
"code": "3000",
"name": "Equity",
"value": 20000,
"items": [
{
"account_id": "301",
"code": "3100",
"name": "Common Stock",
"value": 5000
},
{
"account_id": "302",
"code": "3200",
"name": "Retained Earnings",
"value": 10000
},
{
"account_id": "303",
"code": "3300",
"name": "Additional Paid-In Capital",
"value": 3000
},
{
"account_id": "304",
"code": "3400",
"name": "Treasury Stock",
"value": -1000
},
{
"account_id": "305",
"code": "3500",
"name": "Other Comprehensive Income",
"value": 3000
}
]
} | | `net_assets` | *Optional[float]* | :heavy_minus_sign: | The net assets of the balance sheet | 1000 | | `custom_mappings` | [OptionalNullable[models.CustomMappings]](../models/custommappings.md) | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | | `updated_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who last updated the object. | 12345 | diff --git a/docs/models/sharedlinkinput.md b/docs/models/sharedlinkinput.md index d50b3361..b36e36e1 100644 --- a/docs/models/sharedlinkinput.md +++ b/docs/models/sharedlinkinput.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `target_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the file or folder to link. | | | `download_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL that can be used to download the file. | https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg | +| `target_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the file or folder to link. | | | `scope` | [OptionalNullable[models.Scope]](../models/scope.md) | :heavy_minus_sign: | The scope of the shared link. | company | | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional password for the shared link. | | | `pass_through` | List[[models.PassThroughBody](../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | \ No newline at end of file diff --git a/docs/models/simpleformfieldoption.md b/docs/models/simpleformfieldoption.md index e7fbca36..f95e0984 100644 --- a/docs/models/simpleformfieldoption.md +++ b/docs/models/simpleformfieldoption.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `label` | *str* | :heavy_check_mark: | N/A | General Channel | -| `option_type` | [models.OptionType](../models/optiontype.md) | :heavy_check_mark: | N/A | | -| `value` | [Optional[models.SimpleFormFieldOptionValue]](../models/simpleformfieldoptionvalue.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `value` | [Optional[models.SimpleFormFieldOptionValue]](../models/simpleformfieldoptionvalue.md) | :heavy_minus_sign: | N/A | | +| `option_type` | [models.OptionType](../models/optiontype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/smsmessagesaddrequest.md b/docs/models/smsmessagesaddrequest.md index e4b87a66..3d872850 100644 --- a/docs/models/smsmessagesaddrequest.md +++ b/docs/models/smsmessagesaddrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `message` | [models.MessageInput](../models/messageinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file +| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | +| `message` | [models.MessageInput](../models/messageinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/smsmessagesupdaterequest.md b/docs/models/smsmessagesupdaterequest.md index 805b2963..35f5c7b4 100644 --- a/docs/models/smsmessagesupdaterequest.md +++ b/docs/models/smsmessagesupdaterequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `message` | [models.MessageInput](../models/messageinput.md) | :heavy_check_mark: | N/A | | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `message` | [models.MessageInput](../models/messageinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sociallink.md b/docs/models/sociallink.md index 305100c3..af9ecfbe 100644 --- a/docs/models/sociallink.md +++ b/docs/models/sociallink.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `url` | *str* | :heavy_check_mark: | URL of the social link, e.g. https://www.twitter.com/apideck | https://www.twitter.com/apideck | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the social link | 12345 | +| `url` | *str* | :heavy_check_mark: | URL of the social link, e.g. https://www.twitter.com/apideck | https://www.twitter.com/apideck | | `type` | *OptionalNullable[str]* | :heavy_minus_sign: | Type of the social link, e.g. twitter | twitter | \ No newline at end of file diff --git a/docs/models/sociallinks.md b/docs/models/sociallinks.md index 0441475d..6b58b4d3 100644 --- a/docs/models/sociallinks.md +++ b/docs/models/sociallinks.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `url` | *str* | :heavy_check_mark: | URL of the social link, e.g. https://www.twitter.com/apideck | https://www.twitter.com/apideck | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the social link | 12345 | +| `url` | *str* | :heavy_check_mark: | URL of the social link, e.g. https://www.twitter.com/apideck | https://www.twitter.com/apideck | | `type` | *OptionalNullable[str]* | :heavy_minus_sign: | Type of the social link, e.g. twitter | twitter | \ No newline at end of file diff --git a/docs/models/uncategorizedaccounts.md b/docs/models/uncategorizedaccounts.md index c0e73977..9c5c2ef3 100644 --- a/docs/models/uncategorizedaccounts.md +++ b/docs/models/uncategorizedaccounts.md @@ -7,9 +7,9 @@ The accounts not categorized in the other sections | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | -| `records` | *Any* | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `code` | *Optional[str]* | :heavy_minus_sign: | The account code of the account | 1100 | | `title` | *Optional[str]* | :heavy_minus_sign: | The name of the account. | Current assets | -| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | \ No newline at end of file +| `type` | [OptionalNullable[models.ProfitAndLossType]](../models/profitandlosstype.md) | :heavy_minus_sign: | The type of profit and loss | Section | +| `total` | *Nullable[float]* | :heavy_check_mark: | The aggregated total of all accounts within this category. | 1000 | +| `records` | *Any* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/unifiedfile.md b/docs/models/unifiedfile.md index 90203381..88d86264 100644 --- a/docs/models/unifiedfile.md +++ b/docs/models/unifiedfile.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | A unique identifier for an object. | 12345 | -| `name` | *Nullable[str]* | :heavy_check_mark: | The name of the file | sample.jpg | -| `type` | [Nullable[models.FileType]](../models/filetype.md) | :heavy_check_mark: | The type of resource. Could be file, folder or url | file | | `downstream_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | +| `name` | *Nullable[str]* | :heavy_check_mark: | The name of the file | sample.jpg | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional description of the file | A sample image | +| `type` | [Nullable[models.FileType]](../models/filetype.md) | :heavy_check_mark: | The type of resource. Could be file, folder or url | file | | `path` | *OptionalNullable[str]* | :heavy_minus_sign: | The full path of the file or folder (includes the file name) | /Documents/sample.jpg | | `mime_type` | *OptionalNullable[str]* | :heavy_minus_sign: | The MIME type of the file. | image/jpeg | | `downloadable` | *Optional[bool]* | :heavy_minus_sign: | Whether the current user can download this file | | diff --git a/docs/models/user.md b/docs/models/user.md index 8b51d282..abd9aadb 100644 --- a/docs/models/user.md +++ b/docs/models/user.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `emails` | List[[models.Email](../models/email.md)] | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the user | 12345 | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The parent user id | 54321 | | `username` | *OptionalNullable[str]* | :heavy_minus_sign: | The username of the user | masterofcoin | @@ -22,6 +21,7 @@ | `status` | *OptionalNullable[str]* | :heavy_minus_sign: | The status of the user | active | | `addresses` | List[[models.Address](../models/address.md)] | :heavy_minus_sign: | N/A | | | `phone_numbers` | List[[models.PhoneNumber](../models/phonenumber.md)] | :heavy_minus_sign: | N/A | | +| `emails` | List[[models.Email](../models/email.md)] | :heavy_check_mark: | N/A | | | `custom_mappings` | [OptionalNullable[models.CustomMappings]](../models/custommappings.md) | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | | `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the user was last updated. | 2017-08-12T20:43:21.291Z | | `created_at` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time when the user was created. | 2017-08-12T20:43:21.291Z | diff --git a/docs/models/userinput.md b/docs/models/userinput.md index 10ea7572..790cd566 100644 --- a/docs/models/userinput.md +++ b/docs/models/userinput.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `emails` | List[[models.Email](../models/email.md)] | :heavy_check_mark: | N/A | | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The parent user id | 54321 | | `username` | *OptionalNullable[str]* | :heavy_minus_sign: | The username of the user | masterofcoin | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | @@ -22,4 +21,5 @@ | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | The password of the user | supersecretpassword | | `addresses` | List[[models.Address](../models/address.md)] | :heavy_minus_sign: | N/A | | | `phone_numbers` | List[[models.PhoneNumber](../models/phonenumber.md)] | :heavy_minus_sign: | N/A | | +| `emails` | List[[models.Email](../models/email.md)] | :heavy_check_mark: | N/A | | | `pass_through` | List[[models.PassThroughBody](../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | \ No newline at end of file diff --git a/docs/models/vaultconnectioncustommappingsallrequest.md b/docs/models/vaultconnectioncustommappingsallrequest.md index e58ff5b6..62750cc6 100644 --- a/docs/models/vaultconnectioncustommappingsallrequest.md +++ b/docs/models/vaultconnectioncustommappingsallrequest.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `resource_id` | *Optional[str]* | :heavy_minus_sign: | This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. | 1234 | \ No newline at end of file diff --git a/docs/models/vaultconnectionsdeleterequest.md b/docs/models/vaultconnectionsdeleterequest.md index 4455ec5e..e6d3773c 100644 --- a/docs/models/vaultconnectionsdeleterequest.md +++ b/docs/models/vaultconnectionsdeleterequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | \ No newline at end of file diff --git a/docs/models/vaultconnectionsettingsallrequest.md b/docs/models/vaultconnectionsettingsallrequest.md index a4607d5d..f3863f63 100644 --- a/docs/models/vaultconnectionsettingsallrequest.md +++ b/docs/models/vaultconnectionsettingsallrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | \ No newline at end of file diff --git a/docs/models/vaultconnectionsettingsupdaterequest.md b/docs/models/vaultconnectionsettingsupdaterequest.md index 41fe6185..a0604fe8 100644 --- a/docs/models/vaultconnectionsettingsupdaterequest.md +++ b/docs/models/vaultconnectionsettingsupdaterequest.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | -| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | \ No newline at end of file diff --git a/docs/models/vaultconnectionsimportrequest.md b/docs/models/vaultconnectionsimportrequest.md index 878d650a..b692e1eb 100644 --- a/docs/models/vaultconnectionsimportrequest.md +++ b/docs/models/vaultconnectionsimportrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `connection_import_data` | [models.ConnectionImportData](../models/connectionimportdata.md) | :heavy_check_mark: | Fields that need to be persisted on the resource | | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `connection_import_data` | [models.ConnectionImportData](../models/connectionimportdata.md) | :heavy_check_mark: | Fields that need to be persisted on the resource | | \ No newline at end of file diff --git a/docs/models/vaultconnectionsonerequest.md b/docs/models/vaultconnectionsonerequest.md index a52244f1..1881cc4c 100644 --- a/docs/models/vaultconnectionsonerequest.md +++ b/docs/models/vaultconnectionsonerequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | \ No newline at end of file diff --git a/docs/models/vaultconnectionstokenrequest.md b/docs/models/vaultconnectionstokenrequest.md index a2dc8721..20b34421 100644 --- a/docs/models/vaultconnectionstokenrequest.md +++ b/docs/models/vaultconnectionstokenrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `request_body` | [Optional[models.VaultConnectionsTokenRequestBody]](../models/vaultconnectionstokenrequestbody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/vaultconnectionsupdaterequest.md b/docs/models/vaultconnectionsupdaterequest.md index 031e82a7..78a4234d 100644 --- a/docs/models/vaultconnectionsupdaterequest.md +++ b/docs/models/vaultconnectionsupdaterequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | \ No newline at end of file diff --git a/docs/models/vaultconsumerrequestcountsallrequest.md b/docs/models/vaultconsumerrequestcountsallrequest.md index 38f0f43b..18556dba 100644 --- a/docs/models/vaultconsumerrequestcountsallrequest.md +++ b/docs/models/vaultconsumerrequestcountsallrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | | `start_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened after datetime | 2021-05-01T12:00:00.000Z | -| `end_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened before datetime | 2021-05-30T12:00:00.000Z | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `end_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened before datetime | 2021-05-30T12:00:00.000Z | \ No newline at end of file diff --git a/docs/models/vaultconsumersaddrequest.md b/docs/models/vaultconsumersaddrequest.md index 30fbbd0f..159fc77d 100644 --- a/docs/models/vaultconsumersaddrequest.md +++ b/docs/models/vaultconsumersaddrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `consumer` | [models.ConsumerInput](../models/consumerinput.md) | :heavy_check_mark: | N/A | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `consumer` | [models.ConsumerInput](../models/consumerinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/vaultconsumersdeleterequest.md b/docs/models/vaultconsumersdeleterequest.md index 1c6921a2..716e1f4f 100644 --- a/docs/models/vaultconsumersdeleterequest.md +++ b/docs/models/vaultconsumersdeleterequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | \ No newline at end of file diff --git a/docs/models/vaultconsumersonerequest.md b/docs/models/vaultconsumersonerequest.md index 3b82c6c7..b6f78620 100644 --- a/docs/models/vaultconsumersonerequest.md +++ b/docs/models/vaultconsumersonerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | \ No newline at end of file diff --git a/docs/models/vaultconsumersupdaterequest.md b/docs/models/vaultconsumersupdaterequest.md index 95a5ba1e..e155e7d8 100644 --- a/docs/models/vaultconsumersupdaterequest.md +++ b/docs/models/vaultconsumersupdaterequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | -| `update_consumer_request` | [models.UpdateConsumerRequest](../models/updateconsumerrequest.md) | :heavy_check_mark: | N/A | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `update_consumer_request` | [models.UpdateConsumerRequest](../models/updateconsumerrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/vaultcreatecallbackstaterequest.md b/docs/models/vaultcreatecallbackstaterequest.md index 0a96dbef..d463337c 100644 --- a/docs/models/vaultcreatecallbackstaterequest.md +++ b/docs/models/vaultcreatecallbackstaterequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `create_callback_state` | [models.CreateCallbackState](../models/createcallbackstate.md) | :heavy_check_mark: | Callback state data | | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `create_callback_state` | [models.CreateCallbackState](../models/createcallbackstate.md) | :heavy_check_mark: | Callback state data | | \ No newline at end of file diff --git a/docs/models/vaultcustomfieldsallrequest.md b/docs/models/vaultcustomfieldsallrequest.md index 13f3311b..e6709a6f 100644 --- a/docs/models/vaultcustomfieldsallrequest.md +++ b/docs/models/vaultcustomfieldsallrequest.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `resource_id` | *Optional[str]* | :heavy_minus_sign: | This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. | 1234 | \ No newline at end of file diff --git a/docs/models/vaultcustommappingsallrequest.md b/docs/models/vaultcustommappingsallrequest.md index 5b00eaf5..5b1ce210 100644 --- a/docs/models/vaultcustommappingsallrequest.md +++ b/docs/models/vaultcustommappingsallrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | \ No newline at end of file diff --git a/docs/models/vaultvalidateconnectionstaterequest.md b/docs/models/vaultvalidateconnectionstaterequest.md index 36fdac1c..ac260155 100644 --- a/docs/models/vaultvalidateconnectionstaterequest.md +++ b/docs/models/vaultvalidateconnectionstaterequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `request_body` | [Optional[models.VaultValidateConnectionStateRequestBody]](../models/vaultvalidateconnectionstaterequestbody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/webhook.md b/docs/models/webhook.md index 04bd3f44..0cc0d608 100644 --- a/docs/models/webhook.md +++ b/docs/models/webhook.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | 1234 | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | | `unified_api` | [models.UnifiedAPIID](../models/unifiedapiid.md) | :heavy_check_mark: | Name of Apideck Unified API | crm | | `status` | [models.Status](../models/status.md) | :heavy_check_mark: | The status of the webhook. | enabled | +| `disabled_reason` | [Optional[models.DisabledReason]](../models/disabledreason.md) | :heavy_minus_sign: | Indicates if the webhook has has been disabled as it reached its retry limit or if account is over the usage allocated by it's plan. | retry_limit | | `delivery_url` | *str* | :heavy_check_mark: | The delivery url of the webhook endpoint. | https://example.com/my/webhook/endpoint | | `execute_base_url` | *str* | :heavy_check_mark: | The Unify Base URL events from connectors will be sent to after service id is appended. | https://unify.apideck.com/webhook/webhooks/1234/execute | | `events` | List[[models.WebhookEventType](../models/webhookeventtype.md)] | :heavy_check_mark: | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | [
"vault.connection.created",
"vault.connection.updated"
] | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | 1234 | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | -| `disabled_reason` | [Optional[models.DisabledReason]](../models/disabledreason.md) | :heavy_minus_sign: | Indicates if the webhook has has been disabled as it reached its retry limit or if account is over the usage allocated by it's plan. | retry_limit | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The date and time when the object was last updated. | 2020-09-30T07:43:32.000Z | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The date and time when the object was created. | 2020-09-30T07:43:32.000Z | \ No newline at end of file diff --git a/docs/models/webhookwebhooksaddrequest.md b/docs/models/webhookwebhooksaddrequest.md index a62e4733..df4716b2 100644 --- a/docs/models/webhookwebhooksaddrequest.md +++ b/docs/models/webhookwebhooksaddrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `create_webhook_request` | [models.CreateWebhookRequest](../models/createwebhookrequest.md) | :heavy_check_mark: | N/A | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `create_webhook_request` | [models.CreateWebhookRequest](../models/createwebhookrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/webhookwebhooksupdaterequest.md b/docs/models/webhookwebhooksupdaterequest.md index 715311db..96685ab6 100644 --- a/docs/models/webhookwebhooksupdaterequest.md +++ b/docs/models/webhookwebhooksupdaterequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | | -| `update_webhook_request` | [models.UpdateWebhookRequest](../models/updatewebhookrequest.md) | :heavy_check_mark: | N/A | | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `update_webhook_request` | [models.UpdateWebhookRequest](../models/updatewebhookrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/website.md b/docs/models/website.md index 2cbbf907..3090bc1b 100644 --- a/docs/models/website.md +++ b/docs/models/website.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `url` | *str* | :heavy_check_mark: | The website URL | http://example.com | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier for the website | 12345 | +| `url` | *str* | :heavy_check_mark: | The website URL | http://example.com | | `type` | [OptionalNullable[models.WebsiteType]](../models/websitetype.md) | :heavy_minus_sign: | The type of website | primary | \ No newline at end of file diff --git a/docs/models/websites.md b/docs/models/websites.md index 652058f1..d655c2ea 100644 --- a/docs/models/websites.md +++ b/docs/models/websites.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `url` | *str* | :heavy_check_mark: | The website URL | http://example.com | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier for the website | 12345 | +| `url` | *str* | :heavy_check_mark: | The website URL | http://example.com | | `type` | [OptionalNullable[models.ApplicantType]](../models/applicanttype.md) | :heavy_minus_sign: | The type of website | primary | \ No newline at end of file diff --git a/docs/sdks/apideckcompanies/README.md b/docs/sdks/apideckcompanies/README.md index 14e1a630..565a89f1 100644 --- a/docs/sdks/apideckcompanies/README.md +++ b/docs/sdks/apideckcompanies/README.md @@ -141,36 +141,36 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], debtor_id="12345", pass_through=[ @@ -401,46 +401,46 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], debtor_id="12345", pass_through=[ diff --git a/docs/sdks/applicants/README.md b/docs/sdks/applicants/README.md index 3b59d23c..c22354c7 100644 --- a/docs/sdks/applicants/README.md +++ b/docs/sdks/applicants/README.md @@ -92,13 +92,13 @@ with Apideck( res = apideck.ats.applicants.create(consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], custom_fields=[ @@ -116,10 +116,10 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, @@ -204,24 +204,24 @@ with Apideck( }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.ApplicantType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.ApplicantType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.ApplicantType.PRIMARY, }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], stage_id="12345", recruiter_id="12345", coordinator_id="12345", application_ids=[ @@ -390,18 +390,18 @@ with Apideck( res = apideck.ats.applicants.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], custom_fields=[ @@ -422,18 +422,18 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, @@ -518,24 +518,24 @@ with Apideck( }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.ApplicantType.PRIMARY, }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], stage_id="12345", recruiter_id="12345", coordinator_id="12345", application_ids=[ diff --git a/docs/sdks/bills/README.md b/docs/sdks/bills/README.md index 1e308e09..7610b6c9 100644 --- a/docs/sdks/bills/README.md +++ b/docs/sdks/bills/README.md @@ -138,8 +138,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -179,8 +179,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -436,8 +436,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -477,8 +477,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -518,8 +518,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", diff --git a/docs/sdks/companies/README.md b/docs/sdks/companies/README.md index 9d4b57da..937b5f6c 100644 --- a/docs/sdks/companies/README.md +++ b/docs/sdks/companies/README.md @@ -123,13 +123,13 @@ with Apideck( }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], addresses=[ @@ -187,33 +187,33 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], row_type={ @@ -500,13 +500,13 @@ with Apideck( }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], addresses=[ @@ -564,46 +564,46 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], row_type={ diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md index 871682dc..e1bc5619 100644 --- a/docs/sdks/connections/README.md +++ b/docs/sdks/connections/README.md @@ -152,39 +152,32 @@ with Apideck( "id": "ProductInterest", "options": [ { + "id": "1234", "label": "General Channel", "options": [ { "label": "General Channel", + "value": 12.5, "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, }, { "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, "value": [ "team", "general", ], + "option_type": apideck_unify.OptionType.SIMPLE, }, ], "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", }, { "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], - }, + "value": [ + "team", + "general", ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", + "option_type": apideck_unify.OptionType.SIMPLE, }, ], "value": 10.5, @@ -194,11 +187,8 @@ with Apideck( "options": [ { "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], }, ], "value": True, @@ -213,8 +203,8 @@ with Apideck( "options": [ { "label": "General Channel", + "value": True, "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, }, ], "value": True, @@ -224,73 +214,41 @@ with Apideck( "options": [ { "label": "General Channel", + "value": True, "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", }, { + "id": "1234", "label": "General Channel", "options": [ { "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, "value": 12.5, - }, - { - "label": "General Channel", "option_type": apideck_unify.OptionType.SIMPLE, - "value": True, }, ], "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", }, ], - "value": 10, + "value": "GC5000 series", }, { "id": "ProductInterest", "options": [ { "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", - }, - ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", - }, - { - "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", - }, + "value": [ + "team", + "general", ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", + "option_type": apideck_unify.OptionType.SIMPLE, }, ], - "value": 10.5, + "value": [ + 10.5, + 10, + "GC6000 series", + ], }, ], }, @@ -301,73 +259,48 @@ with Apideck( "id": "ProductInterest", "options": [ { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, - }, - { + "id": "1234", "label": "General Channel", "options": [ { "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], }, { "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": True, }, { "label": "General Channel", + "value": 123, "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, }, ], "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", }, { + "id": "1234", "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, + "options": [ + + ], + "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, }, ], - "value": "GC5000 series", + "value": True, }, { "id": "ProductInterest", "options": [ { "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", - }, - ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", - }, - { - "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, }, ], - "value": 10.5, + "value": True, }, ], }, @@ -375,6 +308,9 @@ with Apideck( { "value": "$.root.training.first_aid", }, + { + "value": "$.root.training.first_aid", + }, ]) assert res.update_connection_response is not None diff --git a/docs/sdks/connectionsettings/README.md b/docs/sdks/connectionsettings/README.md index ec460406..6a41342d 100644 --- a/docs/sdks/connectionsettings/README.md +++ b/docs/sdks/connectionsettings/README.md @@ -96,39 +96,32 @@ with Apideck( "id": "ProductInterest", "options": [ { + "id": "1234", "label": "General Channel", "options": [ { "label": "General Channel", + "value": 12.5, "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, }, { "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, "value": [ "team", "general", ], + "option_type": apideck_unify.OptionType.SIMPLE, }, ], "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", }, { "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], - }, + "value": [ + "team", + "general", ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", + "option_type": apideck_unify.OptionType.SIMPLE, }, ], "value": 10.5, @@ -138,11 +131,8 @@ with Apideck( "options": [ { "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], }, ], "value": True, @@ -157,8 +147,8 @@ with Apideck( "options": [ { "label": "General Channel", + "value": True, "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, }, ], "value": True, @@ -168,73 +158,41 @@ with Apideck( "options": [ { "label": "General Channel", + "value": True, "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", }, { + "id": "1234", "label": "General Channel", "options": [ { "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, "value": 12.5, - }, - { - "label": "General Channel", "option_type": apideck_unify.OptionType.SIMPLE, - "value": True, }, ], "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", }, ], - "value": 10, + "value": "GC5000 series", }, { "id": "ProductInterest", "options": [ { "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", - }, - ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", - }, - { - "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", - }, + "value": [ + "team", + "general", ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", + "option_type": apideck_unify.OptionType.SIMPLE, }, ], - "value": 10.5, + "value": [ + 10.5, + 10, + "GC6000 series", + ], }, ], }, @@ -245,73 +203,48 @@ with Apideck( "id": "ProductInterest", "options": [ { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, - }, - { + "id": "1234", "label": "General Channel", "options": [ { "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], }, { "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": True, }, { "label": "General Channel", + "value": 123, "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, }, ], "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", }, { + "id": "1234", "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": 12.5, + "options": [ + + ], + "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, }, ], - "value": "GC5000 series", + "value": True, }, { "id": "ProductInterest", "options": [ { "label": "General Channel", - "options": [ - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": [ - "team", - "general", - ], - }, - { - "label": "General Channel", - "option_type": apideck_unify.OptionType.SIMPLE, - "value": "general", - }, - ], - "option_type": apideck_unify.FormFieldOptionGroupOptionType.GROUP, - "id": "1234", - }, - { - "label": "General Channel", + "value": "general", "option_type": apideck_unify.OptionType.SIMPLE, - "value": 123, }, ], - "value": 10.5, + "value": True, }, ], }, @@ -319,6 +252,9 @@ with Apideck( { "value": "$.root.training.first_aid", }, + { + "value": "$.root.training.first_aid", + }, ]) assert res.update_connection_response is not None diff --git a/docs/sdks/contacts/README.md b/docs/sdks/contacts/README.md index 1b01d6ef..4962430b 100644 --- a/docs/sdks/contacts/README.md +++ b/docs/sdks/contacts/README.md @@ -99,13 +99,13 @@ with Apideck( res = apideck.crm.contacts.create(name="Elon Musk", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], addresses=[ @@ -163,28 +163,28 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], email_domain="gmail.com", custom_fields=[ @@ -438,18 +438,18 @@ with Apideck( res = apideck.crm.contacts.update(id="", name="Elon Musk", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], addresses=[ @@ -507,49 +507,49 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], email_domain="gmail.com", custom_fields=[ diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md index a6c2dff2..b99f7d27 100644 --- a/docs/sdks/creditnotes/README.md +++ b/docs/sdks/creditnotes/README.md @@ -118,8 +118,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -174,8 +174,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -493,8 +493,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -552,8 +552,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -608,8 +608,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md index d14fb57f..625a08a8 100644 --- a/docs/sdks/customers/README.md +++ b/docs/sdks/customers/README.md @@ -156,36 +156,36 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], bank_accounts=[ @@ -525,46 +525,46 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], bank_accounts=[ diff --git a/docs/sdks/employees/README.md b/docs/sdks/employees/README.md index dcdc72ab..e70e1e47 100644 --- a/docs/sdks/employees/README.md +++ b/docs/sdks/employees/README.md @@ -268,25 +268,25 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], custom_fields=[ @@ -302,8 +302,8 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], bank_accounts=[ @@ -735,35 +735,35 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], custom_fields=[ @@ -781,18 +781,18 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], bank_accounts=[ diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md index fcadf65c..e1fbbd24 100644 --- a/docs/sdks/expenses/README.md +++ b/docs/sdks/expenses/README.md @@ -85,7 +85,6 @@ with Apideck( res = apideck.accounting.expenses.create(transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), account_id="123456", line_items=[ { - "total_amount": 275, "tracking_categories": [ { "id": "123456", @@ -100,11 +99,13 @@ with Apideck( "customer_id": "12345", "department_id": "12345", "location_id": "12345", + "subsidiary_id": "12345", "tax_rate": { "id": "123456", "rate": 10, }, "description": "Travel US.", + "total_amount": 275, "billable": True, }, ], consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={ @@ -304,7 +305,6 @@ with Apideck( res = apideck.accounting.expenses.update(id="", transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), account_id="123456", line_items=[ { - "total_amount": 275, "tracking_categories": [ { "id": "123456", @@ -319,15 +319,16 @@ with Apideck( "customer_id": "12345", "department_id": "12345", "location_id": "12345", + "subsidiary_id": "12345", "tax_rate": { "id": "123456", "rate": 10, }, "description": "Travel US.", + "total_amount": 275, "billable": True, }, { - "total_amount": 275, "tracking_categories": [ { "id": "123456", @@ -342,15 +343,16 @@ with Apideck( "customer_id": "12345", "department_id": "12345", "location_id": "12345", + "subsidiary_id": "12345", "tax_rate": { "id": "123456", "rate": 10, }, "description": "Travel US.", + "total_amount": 275, "billable": True, }, { - "total_amount": 275, "tracking_categories": [ { "id": "123456", @@ -369,11 +371,13 @@ with Apideck( "customer_id": "12345", "department_id": "12345", "location_id": "12345", + "subsidiary_id": "12345", "tax_rate": { "id": "123456", "rate": 10, }, "description": "Travel US.", + "total_amount": 275, "billable": True, }, ], consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={ diff --git a/docs/sdks/invoices/README.md b/docs/sdks/invoices/README.md index 4fec0b09..90807d9e 100644 --- a/docs/sdks/invoices/README.md +++ b/docs/sdks/invoices/README.md @@ -125,8 +125,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -175,8 +175,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -510,8 +510,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -572,8 +572,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", diff --git a/docs/sdks/journalentries/README.md b/docs/sdks/journalentries/README.md index b8cb81ae..40e6f1bd 100644 --- a/docs/sdks/journalentries/README.md +++ b/docs/sdks/journalentries/README.md @@ -97,16 +97,11 @@ with Apideck( res = apideck.accounting.journal_entries.create(consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", title="Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", currency_rate=0.69, currency=apideck_unify.Currency.USD, company_id="12345", line_items=[ { - "type": apideck_unify.JournalEntryLineItemType.DEBIT, - "ledger_account": { - "id": "123456", - "nominal_code": "N091", - "code": "453", - }, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, + "type": apideck_unify.JournalEntryLineItemType.DEBIT, "tax_rate": { "id": "123456", "rate": 10, @@ -121,6 +116,11 @@ with Apideck( "name": "New York", }, ], + "ledger_account": { + "id": "123456", + "nominal_code": "N091", + "code": "453", + }, "customer": { "id": "12345", "display_name": "Windsurf Shop", @@ -156,19 +156,16 @@ with Apideck( "row_version": "1-12345", }, }, + "department_id": "12345", + "location_id": "12345", "line_number": 1, }, { - "type": apideck_unify.JournalEntryLineItemType.DEBIT, - "ledger_account": { - "id": "123456", - "nominal_code": "N091", - "code": "453", - }, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, + "type": apideck_unify.JournalEntryLineItemType.DEBIT, "tax_rate": { "id": "123456", "rate": 10, @@ -183,6 +180,11 @@ with Apideck( "name": "New York", }, ], + "ledger_account": { + "id": "123456", + "nominal_code": "N091", + "code": "453", + }, "customer": { "id": "12345", "display_name": "Windsurf Shop", @@ -218,6 +220,8 @@ with Apideck( "row_version": "1-12345", }, }, + "department_id": "12345", + "location_id": "12345", "line_number": 1, }, ], memo="Thank you for your business and have a great day!", posted_at=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), journal_symbol="IND", tax_type="sales", tax_code="1234", number="OIT00546", tracking_categories=[ @@ -374,16 +378,11 @@ with Apideck( res = apideck.accounting.journal_entries.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", title="Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", currency_rate=0.69, currency=apideck_unify.Currency.USD, company_id="12345", line_items=[ { - "type": apideck_unify.JournalEntryLineItemType.DEBIT, - "ledger_account": { - "id": "123456", - "nominal_code": "N091", - "code": "453", - }, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, + "type": apideck_unify.JournalEntryLineItemType.DEBIT, "tax_rate": { "id": "123456", "rate": 10, @@ -398,6 +397,11 @@ with Apideck( "name": "New York", }, ], + "ledger_account": { + "id": "123456", + "nominal_code": "N091", + "code": "453", + }, "customer": { "id": "12345", "display_name": "Windsurf Shop", @@ -433,19 +437,16 @@ with Apideck( "row_version": "1-12345", }, }, + "department_id": "12345", + "location_id": "12345", "line_number": 1, }, { - "type": apideck_unify.JournalEntryLineItemType.DEBIT, - "ledger_account": { - "id": "123456", - "nominal_code": "N091", - "code": "453", - }, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, + "type": apideck_unify.JournalEntryLineItemType.DEBIT, "tax_rate": { "id": "123456", "rate": 10, @@ -460,6 +461,11 @@ with Apideck( "name": "New York", }, ], + "ledger_account": { + "id": "123456", + "nominal_code": "N091", + "code": "453", + }, "customer": { "id": "12345", "display_name": "Windsurf Shop", @@ -495,19 +501,16 @@ with Apideck( "row_version": "1-12345", }, }, + "department_id": "12345", + "location_id": "12345", "line_number": 1, }, { - "type": apideck_unify.JournalEntryLineItemType.DEBIT, - "ledger_account": { - "id": "123456", - "nominal_code": "N091", - "code": "453", - }, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, + "type": apideck_unify.JournalEntryLineItemType.DEBIT, "tax_rate": { "id": "123456", "rate": 10, @@ -526,6 +529,11 @@ with Apideck( "name": "New York", }, ], + "ledger_account": { + "id": "123456", + "nominal_code": "N091", + "code": "453", + }, "customer": { "id": "12345", "display_name": "Windsurf Shop", @@ -561,6 +569,8 @@ with Apideck( "row_version": "1-12345", }, }, + "department_id": "12345", + "location_id": "12345", "line_number": 1, }, ], memo="Thank you for your business and have a great day!", posted_at=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), journal_symbol="IND", tax_type="sales", tax_code="1234", number="OIT00546", tracking_categories=[ diff --git a/docs/sdks/leads/README.md b/docs/sdks/leads/README.md index cbe37fbb..78b5f247 100644 --- a/docs/sdks/leads/README.md +++ b/docs/sdks/leads/README.md @@ -98,13 +98,13 @@ with Apideck( res = apideck.crm.leads.create(name="Elon Musk", company_name="Spacex", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="54321", owner_name="John Doe", company_id="2", lead_id="2", lead_source="Cold Call", first_name="Elon", last_name="Musk", description="A thinker", prefix="Sir", title="CEO", language="EN", status="New", monetary_amount=75000, currency=apideck_unify.Currency.USD, fax="+12129876543", websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], addresses=[ @@ -162,28 +162,28 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], custom_fields=[ @@ -419,18 +419,18 @@ with Apideck( res = apideck.crm.leads.update(id="", name="Elon Musk", company_name="Spacex", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="54321", owner_name="John Doe", company_id="2", lead_id="2", lead_source="Cold Call", first_name="Elon", last_name="Musk", description="A thinker", prefix="Sir", title="CEO", language="EN", status="New", monetary_amount=75000, currency=apideck_unify.Currency.USD, fax="+12129876543", websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], addresses=[ @@ -488,49 +488,49 @@ with Apideck( }, ], social_links=[ { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, { - "url": "https://www.twitter.com/apideck", "id": "12345", + "url": "https://www.twitter.com/apideck", "type": "twitter", }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], custom_fields=[ diff --git a/docs/sdks/purchaseorders/README.md b/docs/sdks/purchaseorders/README.md index a926523a..752d13d7 100644 --- a/docs/sdks/purchaseorders/README.md +++ b/docs/sdks/purchaseorders/README.md @@ -139,8 +139,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -195,8 +195,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -306,59 +306,25 @@ with Apideck( "id": "2389328923893298", "name": "employee_level", "description": "Employee Level", - "value": True, + "value": {}, }, - ], row_version="1-12345", pass_through=[ { - "service_id": "", - "extend_paths": [ - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, + "id": "2389328923893298", + "name": "employee_level", + "description": "Employee Level", + "value": [ + "", + "", + "", ], }, { - "service_id": "", - "extend_paths": [ - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, - ], + "id": "2389328923893298", + "name": "employee_level", + "description": "Employee Level", + "value": True, }, + ], row_version="1-12345", pass_through=[ { "service_id": "", "extend_paths": [ @@ -370,22 +336,6 @@ with Apideck( }, }, }, - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, ], }, ]) @@ -567,8 +517,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -626,8 +576,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -682,8 +632,8 @@ with Apideck( "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, - "location_id": "1234", - "department_id": "1234", + "location_id": "12345", + "department_id": "12345", "item": { "id": "12344", "code": "120-C", @@ -773,24 +723,24 @@ with Apideck( "id": "2389328923893298", "name": "employee_level", "description": "Employee Level", - "value": [ - {}, - ], + "value": 10, }, - ], row_version="1-12345", pass_through=[ { - "service_id": "", - "extend_paths": [ - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, + "id": "2389328923893298", + "name": "employee_level", + "description": "Employee Level", + "value": True, + }, + { + "id": "2389328923893298", + "name": "employee_level", + "description": "Employee Level", + "value": [ + "", + "", ], }, + ], row_version="1-12345", pass_through=[ { "service_id": "", "extend_paths": [ @@ -802,14 +752,6 @@ with Apideck( }, }, }, - { - "path": "$.nested.property", - "value": { - "TaxClassificationRef": { - "value": "EUC-99990201-V1-00020000", - }, - }, - }, ], }, { diff --git a/docs/sdks/suppliers/README.md b/docs/sdks/suppliers/README.md index 9805b0be..8b9a3c89 100644 --- a/docs/sdks/suppliers/README.md +++ b/docs/sdks/suppliers/README.md @@ -154,36 +154,36 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], bank_accounts=[ @@ -519,46 +519,46 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, ], emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], websites=[ { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, { - "url": "http://example.com", "id": "12345", + "url": "http://example.com", "type": apideck_unify.WebsiteType.PRIMARY, }, ], bank_accounts=[ diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index 56b67326..58ebe99f 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -88,8 +88,8 @@ with Apideck( res = apideck.crm.users.create(emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="54321", username="masterofcoin", first_name="Elon", last_name="Musk", title="CEO", division="Europe", company_name="SpaceX", employee_number="123456-AB", description="A description", image="https://logo.clearbit.com/spacex.com?s=128", language="EN", status="active", password="supersecretpassword", addresses=[ @@ -147,18 +147,18 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, @@ -301,8 +301,8 @@ with Apideck( res = apideck.crm.users.update(id="", emails=[ { - "email": "elon@musk.com", "id": "123", + "email": "elon@musk.com", "type": apideck_unify.EmailType.PRIMARY, }, ], consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="54321", username="masterofcoin", first_name="Elon", last_name="Musk", title="CEO", division="Europe", company_name="SpaceX", employee_number="123456-AB", description="A description", image="https://logo.clearbit.com/spacex.com?s=128", language="EN", status="active", password="supersecretpassword", addresses=[ @@ -386,18 +386,18 @@ with Apideck( }, ], phone_numbers=[ { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, { - "number": "111-111-1111", "id": "12345", "country_code": "1", "area_code": "323", + "number": "111-111-1111", "extension": "105", "type": apideck_unify.PhoneNumberType.PRIMARY, }, diff --git a/pylintrc b/pylintrc index 9d666c79..bbbd1db1 100644 --- a/pylintrc +++ b/pylintrc @@ -188,8 +188,8 @@ good-names=i, Run, _, e, - id, by, + id, to # Good variable names regexes, separated by a comma. If names match any regex, diff --git a/pyproject.toml b/pyproject.toml index b7373446..f6c9d641 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "apideck-unify" -version = "0.10.0" +version = "0.10.1" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" diff --git a/src/apideck_unify/_version.py b/src/apideck_unify/_version.py index b9dfbaa6..78c02869 100644 --- a/src/apideck_unify/_version.py +++ b/src/apideck_unify/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "apideck-unify" -__version__: str = "0.10.0" +__version__: str = "0.10.1" __openapi_doc_version__: str = "10.14.1" -__gen_version__: str = "2.565.1" -__user_agent__: str = "speakeasy-sdk/python 0.10.0 2.565.1 10.14.1 apideck-unify" +__gen_version__: str = "2.568.2" +__user_agent__: str = "speakeasy-sdk/python 0.10.1 2.568.2 10.14.1 apideck-unify" try: if __package__ is not None: diff --git a/src/apideck_unify/activities.py b/src/apideck_unify/activities.py index a6e4f96d..f82c6c53 100644 --- a/src/apideck_unify/activities.py +++ b/src/apideck_unify/activities.py @@ -106,7 +106,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -305,7 +305,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -636,7 +636,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -940,7 +940,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1094,7 +1094,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1248,7 +1248,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1555,7 +1555,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1862,7 +1862,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -2013,7 +2013,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2164,7 +2164,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/agedcreditors_sdk.py b/src/apideck_unify/agedcreditors_sdk.py index 34f1d232..11b29c73 100644 --- a/src/apideck_unify/agedcreditors_sdk.py +++ b/src/apideck_unify/agedcreditors_sdk.py @@ -94,7 +94,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -255,7 +255,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/ageddebtors_sdk.py b/src/apideck_unify/ageddebtors_sdk.py index f4568025..9924f065 100644 --- a/src/apideck_unify/ageddebtors_sdk.py +++ b/src/apideck_unify/ageddebtors_sdk.py @@ -94,7 +94,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -255,7 +255,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/apideck_companies.py b/src/apideck_unify/apideck_companies.py index a79084e8..6fd64d5f 100644 --- a/src/apideck_unify/apideck_companies.py +++ b/src/apideck_unify/apideck_companies.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -509,7 +509,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -714,7 +714,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -868,7 +868,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1022,7 +1022,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1230,7 +1230,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1438,7 +1438,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1589,7 +1589,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1740,7 +1740,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/apideck_customers.py b/src/apideck_unify/apideck_customers.py index 4573e05a..611b9a69 100644 --- a/src/apideck_unify/apideck_customers.py +++ b/src/apideck_unify/apideck_customers.py @@ -104,7 +104,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -300,7 +300,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -480,7 +480,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -634,7 +634,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/apideck_departments.py b/src/apideck_unify/apideck_departments.py index 637e0681..e5c40863 100644 --- a/src/apideck_unify/apideck_departments.py +++ b/src/apideck_unify/apideck_departments.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -473,7 +473,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -642,7 +642,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -796,7 +796,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -950,7 +950,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1122,7 +1122,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1294,7 +1294,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1445,7 +1445,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1596,7 +1596,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/apiresourcecoverage_sdk.py b/src/apideck_unify/apiresourcecoverage_sdk.py index c59fe45c..7d117945 100644 --- a/src/apideck_unify/apiresourcecoverage_sdk.py +++ b/src/apideck_unify/apiresourcecoverage_sdk.py @@ -77,7 +77,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -211,7 +211,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/apiresources.py b/src/apideck_unify/apiresources.py index 0b2c881d..3cbdd989 100644 --- a/src/apideck_unify/apiresources.py +++ b/src/apideck_unify/apiresources.py @@ -77,7 +77,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -211,7 +211,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/apis.py b/src/apideck_unify/apis.py index 06956603..1ba5626a 100644 --- a/src/apideck_unify/apis.py +++ b/src/apideck_unify/apis.py @@ -81,7 +81,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -239,7 +239,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -391,7 +391,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -522,7 +522,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/applicants.py b/src/apideck_unify/applicants.py index b234b3a7..13ae8562 100644 --- a/src/apideck_unify/applicants.py +++ b/src/apideck_unify/applicants.py @@ -102,7 +102,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -295,7 +295,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -591,7 +591,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -861,7 +861,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1015,7 +1015,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1169,7 +1169,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1442,7 +1442,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1715,7 +1715,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1866,7 +1866,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2017,7 +2017,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/applications.py b/src/apideck_unify/applications.py index 08d5ad0d..33c7977e 100644 --- a/src/apideck_unify/applications.py +++ b/src/apideck_unify/applications.py @@ -91,7 +91,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -272,7 +272,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -468,7 +468,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -640,7 +640,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -791,7 +791,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -942,7 +942,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1117,7 +1117,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1292,7 +1292,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1443,7 +1443,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1594,7 +1594,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/attachments.py b/src/apideck_unify/attachments.py index 1d61ac00..593f6794 100644 --- a/src/apideck_unify/attachments.py +++ b/src/apideck_unify/attachments.py @@ -104,7 +104,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -293,7 +293,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -486,7 +486,7 @@ def upload( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -653,7 +653,7 @@ async def upload_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -813,7 +813,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -973,7 +973,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1130,7 +1130,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1287,7 +1287,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1448,7 +1448,7 @@ def download( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1614,7 +1614,7 @@ async def download_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/balancesheet_sdk.py b/src/apideck_unify/balancesheet_sdk.py index 81ff2715..35640702 100644 --- a/src/apideck_unify/balancesheet_sdk.py +++ b/src/apideck_unify/balancesheet_sdk.py @@ -91,7 +91,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -249,7 +249,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/billpayments.py b/src/apideck_unify/billpayments.py index 0f302e12..9e7c655c 100644 --- a/src/apideck_unify/billpayments.py +++ b/src/apideck_unify/billpayments.py @@ -103,7 +103,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -298,7 +298,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -578,7 +578,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -831,7 +831,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -985,7 +985,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1139,7 +1139,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1395,7 +1395,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1651,7 +1651,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1802,7 +1802,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1953,7 +1953,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/bills.py b/src/apideck_unify/bills.py index f17d6546..9a3a7d90 100644 --- a/src/apideck_unify/bills.py +++ b/src/apideck_unify/bills.py @@ -103,7 +103,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -298,7 +298,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -617,7 +617,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -909,7 +909,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1063,7 +1063,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1217,7 +1217,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1512,7 +1512,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1807,7 +1807,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1958,7 +1958,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2109,7 +2109,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/collections.py b/src/apideck_unify/collections.py index dcecc81b..55ea3877 100644 --- a/src/apideck_unify/collections.py +++ b/src/apideck_unify/collections.py @@ -99,7 +99,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -290,7 +290,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -470,7 +470,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -624,7 +624,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/collectiontags.py b/src/apideck_unify/collectiontags.py index 4a784183..a799d614 100644 --- a/src/apideck_unify/collectiontags.py +++ b/src/apideck_unify/collectiontags.py @@ -97,7 +97,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -286,7 +286,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/collectionticketcomments.py b/src/apideck_unify/collectionticketcomments.py index fa365e92..5b93b36a 100644 --- a/src/apideck_unify/collectionticketcomments.py +++ b/src/apideck_unify/collectionticketcomments.py @@ -103,7 +103,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -302,7 +302,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -505,7 +505,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -678,7 +678,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -844,7 +844,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1039,7 +1039,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1244,7 +1244,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1420,7 +1420,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1577,7 +1577,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1734,7 +1734,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/collectiontickets.py b/src/apideck_unify/collectiontickets.py index b6d7c900..c7380d47 100644 --- a/src/apideck_unify/collectiontickets.py +++ b/src/apideck_unify/collectiontickets.py @@ -106,7 +106,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -305,7 +305,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -534,7 +534,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -735,7 +735,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -892,7 +892,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1049,7 +1049,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1253,7 +1253,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1457,7 +1457,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1611,7 +1611,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1765,7 +1765,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/collectionusers.py b/src/apideck_unify/collectionusers.py index ef2d8264..d0ef3ce2 100644 --- a/src/apideck_unify/collectionusers.py +++ b/src/apideck_unify/collectionusers.py @@ -97,7 +97,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -286,7 +286,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -469,7 +469,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -626,7 +626,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/companies.py b/src/apideck_unify/companies.py index 74842f60..86cd90c2 100644 --- a/src/apideck_unify/companies.py +++ b/src/apideck_unify/companies.py @@ -105,7 +105,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -302,7 +302,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -610,7 +610,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -891,7 +891,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1045,7 +1045,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1199,7 +1199,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1483,7 +1483,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1767,7 +1767,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1918,7 +1918,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2069,7 +2069,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/companyinfo_sdk.py b/src/apideck_unify/companyinfo_sdk.py index b6d67492..a4e3199d 100644 --- a/src/apideck_unify/companyinfo_sdk.py +++ b/src/apideck_unify/companyinfo_sdk.py @@ -84,7 +84,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -235,7 +235,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/connectioncustommappings.py b/src/apideck_unify/connectioncustommappings.py index d276c6ad..0234b05e 100644 --- a/src/apideck_unify/connectioncustommappings.py +++ b/src/apideck_unify/connectioncustommappings.py @@ -87,7 +87,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -241,7 +241,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/connections.py b/src/apideck_unify/connections.py index f50ff17e..82d4e30e 100644 --- a/src/apideck_unify/connections.py +++ b/src/apideck_unify/connections.py @@ -84,7 +84,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -235,7 +235,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -383,7 +383,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -531,7 +531,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -713,7 +713,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -895,7 +895,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1043,7 +1043,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1188,7 +1188,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1360,7 +1360,7 @@ def imports( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1535,7 +1535,7 @@ async def imports_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1706,7 +1706,7 @@ def token( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1877,7 +1877,7 @@ async def token_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/connectionsettings.py b/src/apideck_unify/connectionsettings.py index be38510b..40036355 100644 --- a/src/apideck_unify/connectionsettings.py +++ b/src/apideck_unify/connectionsettings.py @@ -85,7 +85,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -237,7 +237,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -422,7 +422,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -607,7 +607,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/connectordocs.py b/src/apideck_unify/connectordocs.py index a072a9f2..ecb8d0fd 100644 --- a/src/apideck_unify/connectordocs.py +++ b/src/apideck_unify/connectordocs.py @@ -87,7 +87,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -223,7 +223,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/connectorresources.py b/src/apideck_unify/connectorresources.py index 1ade72ce..744642a8 100644 --- a/src/apideck_unify/connectorresources.py +++ b/src/apideck_unify/connectorresources.py @@ -80,7 +80,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -217,7 +217,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/connectors.py b/src/apideck_unify/connectors.py index 9a05f167..6b7bc64f 100644 --- a/src/apideck_unify/connectors.py +++ b/src/apideck_unify/connectors.py @@ -85,7 +85,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -247,7 +247,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -399,7 +399,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -530,7 +530,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/consumerrequestcounts.py b/src/apideck_unify/consumerrequestcounts.py index 490402e9..bdc151e9 100644 --- a/src/apideck_unify/consumerrequestcounts.py +++ b/src/apideck_unify/consumerrequestcounts.py @@ -81,7 +81,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -230,7 +230,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/consumers.py b/src/apideck_unify/consumers.py index 0f7d5d44..74110175 100644 --- a/src/apideck_unify/consumers.py +++ b/src/apideck_unify/consumers.py @@ -87,7 +87,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -240,7 +240,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -385,7 +385,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -550,7 +550,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -712,7 +712,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -854,7 +854,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1011,7 +1011,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1168,7 +1168,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1309,7 +1309,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1450,7 +1450,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/contacts.py b/src/apideck_unify/contacts.py index 0dfe9996..ea48c068 100644 --- a/src/apideck_unify/contacts.py +++ b/src/apideck_unify/contacts.py @@ -102,7 +102,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -297,7 +297,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -603,7 +603,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -882,7 +882,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1041,7 +1041,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1200,7 +1200,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1482,7 +1482,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1764,7 +1764,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1915,7 +1915,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2066,7 +2066,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/createcallback.py b/src/apideck_unify/createcallback.py index a61609e4..14b69565 100644 --- a/src/apideck_unify/createcallback.py +++ b/src/apideck_unify/createcallback.py @@ -94,7 +94,7 @@ def state( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -255,7 +255,7 @@ async def state_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/creditnotes.py b/src/apideck_unify/creditnotes.py index b7e37007..a9f389e8 100644 --- a/src/apideck_unify/creditnotes.py +++ b/src/apideck_unify/creditnotes.py @@ -107,7 +107,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -306,7 +306,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -616,7 +616,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -899,7 +899,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1053,7 +1053,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1207,7 +1207,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1493,7 +1493,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1779,7 +1779,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1930,7 +1930,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2081,7 +2081,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/customers.py b/src/apideck_unify/customers.py index 9ba64331..01127d7a 100644 --- a/src/apideck_unify/customers.py +++ b/src/apideck_unify/customers.py @@ -104,7 +104,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -301,7 +301,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -604,7 +604,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -880,7 +880,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1034,7 +1034,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1188,7 +1188,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1467,7 +1467,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1746,7 +1746,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1897,7 +1897,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2048,7 +2048,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/customfields.py b/src/apideck_unify/customfields.py index e6995ffe..a728a011 100644 --- a/src/apideck_unify/customfields.py +++ b/src/apideck_unify/customfields.py @@ -88,7 +88,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -243,7 +243,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/custommappings_sdk.py b/src/apideck_unify/custommappings_sdk.py index 794e4f0c..b2ed07de 100644 --- a/src/apideck_unify/custommappings_sdk.py +++ b/src/apideck_unify/custommappings_sdk.py @@ -81,7 +81,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -229,7 +229,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/departments.py b/src/apideck_unify/departments.py index b1761a4f..826c09b1 100644 --- a/src/apideck_unify/departments.py +++ b/src/apideck_unify/departments.py @@ -101,7 +101,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -293,7 +293,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -504,7 +504,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -690,7 +690,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -844,7 +844,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -998,7 +998,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1187,7 +1187,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1376,7 +1376,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1527,7 +1527,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1678,7 +1678,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/drivegroups.py b/src/apideck_unify/drivegroups.py index 32b7e5e6..97344181 100644 --- a/src/apideck_unify/drivegroups.py +++ b/src/apideck_unify/drivegroups.py @@ -101,7 +101,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -294,7 +294,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -489,7 +489,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -658,7 +658,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -812,7 +812,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -966,7 +966,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1138,7 +1138,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1310,7 +1310,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1461,7 +1461,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1612,7 +1612,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/drives.py b/src/apideck_unify/drives.py index c8e0aa36..05eb941d 100644 --- a/src/apideck_unify/drives.py +++ b/src/apideck_unify/drives.py @@ -96,7 +96,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -283,7 +283,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -474,7 +474,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -640,7 +640,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -794,7 +794,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -948,7 +948,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1117,7 +1117,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1286,7 +1286,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1437,7 +1437,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1588,7 +1588,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/employeepayrolls.py b/src/apideck_unify/employeepayrolls.py index a2e81965..d327676d 100644 --- a/src/apideck_unify/employeepayrolls.py +++ b/src/apideck_unify/employeepayrolls.py @@ -95,7 +95,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -257,7 +257,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -414,7 +414,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -571,7 +571,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/employees.py b/src/apideck_unify/employees.py index 3eae9102..e0083871 100644 --- a/src/apideck_unify/employees.py +++ b/src/apideck_unify/employees.py @@ -105,7 +105,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -302,7 +302,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -711,7 +711,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1093,7 +1093,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1257,7 +1257,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1421,7 +1421,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1806,7 +1806,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2191,7 +2191,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -2342,7 +2342,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2493,7 +2493,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/employeeschedules_sdk.py b/src/apideck_unify/employeeschedules_sdk.py index 6f5453d0..7a87f819 100644 --- a/src/apideck_unify/employeeschedules_sdk.py +++ b/src/apideck_unify/employeeschedules_sdk.py @@ -90,7 +90,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -247,7 +247,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/eventlogs.py b/src/apideck_unify/eventlogs.py index c6fa3cb0..101149e5 100644 --- a/src/apideck_unify/eventlogs.py +++ b/src/apideck_unify/eventlogs.py @@ -85,7 +85,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -257,7 +257,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/expenses.py b/src/apideck_unify/expenses.py index 14a3d131..33058ac3 100644 --- a/src/apideck_unify/expenses.py +++ b/src/apideck_unify/expenses.py @@ -89,7 +89,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -266,7 +266,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -513,7 +513,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -737,7 +737,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -888,7 +888,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1039,7 +1039,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1266,7 +1266,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1493,7 +1493,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1644,7 +1644,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1795,7 +1795,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/files.py b/src/apideck_unify/files.py index 0b5eb05a..174918b9 100644 --- a/src/apideck_unify/files.py +++ b/src/apideck_unify/files.py @@ -113,7 +113,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -308,7 +308,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -518,7 +518,7 @@ def search( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -701,7 +701,7 @@ async def search_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -855,7 +855,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1009,7 +1009,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1185,7 +1185,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1361,7 +1361,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1512,7 +1512,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1663,7 +1663,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1818,7 +1818,7 @@ def download( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1978,7 +1978,7 @@ async def download_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -2141,7 +2141,7 @@ def export( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2304,7 +2304,7 @@ async def export_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/folders.py b/src/apideck_unify/folders.py index c434e353..3fb93cbe 100644 --- a/src/apideck_unify/folders.py +++ b/src/apideck_unify/folders.py @@ -112,7 +112,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -291,7 +291,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -445,7 +445,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -599,7 +599,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -775,7 +775,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -951,7 +951,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1102,7 +1102,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1253,7 +1253,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1429,7 +1429,7 @@ def copy( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1605,7 +1605,7 @@ async def copy_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/invoiceitems.py b/src/apideck_unify/invoiceitems.py index 4dd615f5..322e3604 100644 --- a/src/apideck_unify/invoiceitems.py +++ b/src/apideck_unify/invoiceitems.py @@ -107,7 +107,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -306,7 +306,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -615,7 +615,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -897,7 +897,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1058,7 +1058,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1219,7 +1219,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1504,7 +1504,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1789,7 +1789,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1940,7 +1940,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2091,7 +2091,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/invoices.py b/src/apideck_unify/invoices.py index 55e2ff13..fea97b4e 100644 --- a/src/apideck_unify/invoices.py +++ b/src/apideck_unify/invoices.py @@ -103,7 +103,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -298,7 +298,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -649,7 +649,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -973,7 +973,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1127,7 +1127,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1281,7 +1281,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1608,7 +1608,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1935,7 +1935,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -2086,7 +2086,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2237,7 +2237,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/jobs.py b/src/apideck_unify/jobs.py index d6b8727e..e10b4b42 100644 --- a/src/apideck_unify/jobs.py +++ b/src/apideck_unify/jobs.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -458,7 +458,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -612,7 +612,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/journalentries.py b/src/apideck_unify/journalentries.py index 8df0bfcf..d9349c20 100644 --- a/src/apideck_unify/journalentries.py +++ b/src/apideck_unify/journalentries.py @@ -107,7 +107,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -306,7 +306,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -557,7 +557,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -781,7 +781,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -935,7 +935,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1089,7 +1089,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1316,7 +1316,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1543,7 +1543,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1694,7 +1694,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1845,7 +1845,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/leads.py b/src/apideck_unify/leads.py index 930e1494..6485bb09 100644 --- a/src/apideck_unify/leads.py +++ b/src/apideck_unify/leads.py @@ -102,7 +102,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -297,7 +297,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -576,7 +576,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -828,7 +828,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -982,7 +982,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1136,7 +1136,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1391,7 +1391,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1646,7 +1646,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1797,7 +1797,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1948,7 +1948,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/ledgeraccounts.py b/src/apideck_unify/ledgeraccounts.py index c789b0de..f31fdc39 100644 --- a/src/apideck_unify/ledgeraccounts.py +++ b/src/apideck_unify/ledgeraccounts.py @@ -107,7 +107,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -306,7 +306,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -591,7 +591,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -849,7 +849,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1003,7 +1003,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1157,7 +1157,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1418,7 +1418,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1679,7 +1679,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1830,7 +1830,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1981,7 +1981,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/locations.py b/src/apideck_unify/locations.py index 094b3d74..e6bb272e 100644 --- a/src/apideck_unify/locations.py +++ b/src/apideck_unify/locations.py @@ -101,7 +101,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -293,7 +293,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -514,7 +514,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -710,7 +710,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -864,7 +864,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1018,7 +1018,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1217,7 +1217,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1416,7 +1416,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1567,7 +1567,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1718,7 +1718,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/logs.py b/src/apideck_unify/logs.py index 1efd3356..451a21e0 100644 --- a/src/apideck_unify/logs.py +++ b/src/apideck_unify/logs.py @@ -86,7 +86,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -260,7 +260,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/messages.py b/src/apideck_unify/messages.py index 4bf3a947..82e43fd9 100644 --- a/src/apideck_unify/messages.py +++ b/src/apideck_unify/messages.py @@ -92,7 +92,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -273,7 +273,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -484,7 +484,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -671,7 +671,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -825,7 +825,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -979,7 +979,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1169,7 +1169,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1359,7 +1359,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1510,7 +1510,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1661,7 +1661,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/models/__init__.py b/src/apideck_unify/models/__init__.py index 2a9870b1..31e5a40a 100644 --- a/src/apideck_unify/models/__init__.py +++ b/src/apideck_unify/models/__init__.py @@ -761,7 +761,7 @@ AccountingTrackingCategoriesUpdateResponse, AccountingTrackingCategoriesUpdateResponseTypedDict, ) -from .accountingdepartment import ( +from .accountingdepartment_input import ( AccountingDepartment, AccountingDepartmentInput, AccountingDepartmentInputTypedDict, @@ -785,7 +785,7 @@ ) from .activitiesfilter import ActivitiesFilter, ActivitiesFilterTypedDict from .activitiessort import ActivitiesSort, ActivitiesSortBy, ActivitiesSortTypedDict -from .activity import ( +from .activity_input import ( Activity, ActivityInput, ActivityInputTypedDict, @@ -793,7 +793,7 @@ ActivityTypedDict, ShowAs, ) -from .activityattendee import ( +from .activityattendee_input import ( ActivityAttendee, ActivityAttendeeInput, ActivityAttendeeInputTypedDict, @@ -804,7 +804,7 @@ from .agedcreditors import AgedCreditors, AgedCreditorsTypedDict from .ageddebtors import AgedDebtors, AgedDebtorsTypedDict from .agedreportfilter import AgedReportFilter, AgedReportFilterTypedDict -from .allocation import ( +from .allocation_input import ( Allocation, AllocationInput, AllocationInputTypedDict, @@ -829,7 +829,7 @@ ) from .apisfilter import ApisFilter, ApisFilterTypedDict from .apistatus import APIStatus -from .applicant import ( +from .applicant_input import ( Applicant, ApplicantInput, ApplicantInputTypedDict, @@ -841,7 +841,7 @@ WebsitesTypedDict, ) from .applicantsfilter import ApplicantsFilter, ApplicantsFilterTypedDict -from .application import ( +from .application_input import ( Application, ApplicationInput, ApplicationInputTypedDict, @@ -984,7 +984,7 @@ ) from .bankaccount import AccountType, BankAccount, BankAccountTypedDict from .benefit import Benefit, BenefitTypedDict -from .bill import Bill, BillInput, BillInputTypedDict, BillStatus, BillTypedDict +from .bill_input import Bill, BillInput, BillInputTypedDict, BillStatus, BillTypedDict from .billlineitem import ( BillLineItem, BillLineItemInput, @@ -1041,7 +1041,7 @@ TheStartMonthOfFiscalYear, ) from .compensation import Compensation, CompensationTypedDict -from .connection import ( +from .connection_input import ( Configuration, ConfigurationTypedDict, Connection, @@ -1169,7 +1169,7 @@ ConsumerRequestCountsInDateRangeResponseDataTypedDict, ConsumerRequestCountsInDateRangeResponseTypedDict, ) -from .contact import ( +from .contact_input import ( Contact, ContactGender, ContactInput, @@ -1323,7 +1323,7 @@ from .createuserresponse import CreateUserResponse, CreateUserResponseTypedDict from .createwebhookrequest import CreateWebhookRequest, CreateWebhookRequestTypedDict from .createwebhookresponse import CreateWebhookResponse, CreateWebhookResponseTypedDict -from .creditnote import ( +from .creditnote_input import ( CreditNote, CreditNoteInput, CreditNoteInputTypedDict, @@ -1928,7 +1928,7 @@ ) from .ecommercestore import EcommerceStore, EcommerceStoreTypedDict from .email import Email, EmailType, EmailTypedDict -from .employee import ( +from .employee_input import ( Employee, EmployeeInput, EmployeeInputTypedDict, @@ -1950,7 +1950,7 @@ EmployeeCompensationTypedDict, FlsaStatus, ) -from .employeejob import ( +from .employeejob_input import ( EmployeeJob, EmployeeJobInput, EmployeeJobInputTypedDict, @@ -2953,7 +2953,7 @@ from .lead_input import LeadInput, LeadInputTypedDict from .leadsfilter import LeadsFilter, LeadsFilterTypedDict from .leadssort import LeadsSort, LeadsSortBy, LeadsSortTypedDict -from .ledgeraccount import ( +from .ledgeraccount_input import ( AccountStatus, Categories, CategoriesTypedDict, @@ -3014,7 +3014,7 @@ UnifiedAPI, ) from .logsfilter import LogsFilter, LogsFilterTypedDict -from .message import ( +from .message_input import ( Direction, Error, ErrorTypedDict, @@ -3116,7 +3116,7 @@ ProfitAndLossIndicatorTypedDict, ) from .profitandlosstype import ProfitAndLossType -from .purchaseorder import ( +from .purchaseorder_input import ( PurchaseOrder, PurchaseOrderInput, PurchaseOrderInputTypedDict, @@ -3215,7 +3215,7 @@ from .sociallink import SocialLink, SocialLinkTypedDict from .sortdirection import SortDirection from .status import Status -from .subsidiary import ( +from .subsidiary_input import ( Subsidiary, SubsidiaryInput, SubsidiaryInputTypedDict, @@ -3238,7 +3238,7 @@ from .supplierssort import SuppliersSort, SuppliersSortBy, SuppliersSortTypedDict from .supportedproperty import SupportedProperty, SupportedPropertyTypedDict from .tax import Tax, TaxTypedDict -from .taxrate import ( +from .taxrate_input import ( Components, ComponentsTypedDict, SubsidiariesModel, @@ -3251,9 +3251,15 @@ ) from .taxratesfilter import TaxRatesFilter, TaxRatesFilterTypedDict from .team import Team, TeamTypedDict -from .ticket import Priority, Ticket, TicketInput, TicketInputTypedDict, TicketTypedDict +from .ticket_input import ( + Priority, + Ticket, + TicketInput, + TicketInputTypedDict, + TicketTypedDict, +) from .ticketssort import TicketsSort, TicketsSortBy, TicketsSortTypedDict -from .timeoffrequest import ( +from .timeoffrequest_input import ( NotesModel, NotesModelTypedDict, RequestType, @@ -3269,7 +3275,7 @@ TimeOffRequestsFilter, TimeOffRequestsFilterTypedDict, ) -from .trackingcategory import ( +from .trackingcategory_input import ( TrackingCategory, TrackingCategoryInput, TrackingCategoryInputTypedDict, diff --git a/src/apideck_unify/models/accounting_billsaddop.py b/src/apideck_unify/models/accounting_billsaddop.py index 3f13340c..e27c153a 100644 --- a/src/apideck_unify/models/accounting_billsaddop.py +++ b/src/apideck_unify/models/accounting_billsaddop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .bill import BillInput, BillInputTypedDict +from .bill_input import BillInput, BillInputTypedDict from .createbillresponse import CreateBillResponse, CreateBillResponseTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( diff --git a/src/apideck_unify/models/accounting_billsupdateop.py b/src/apideck_unify/models/accounting_billsupdateop.py index 10a36a78..df17d150 100644 --- a/src/apideck_unify/models/accounting_billsupdateop.py +++ b/src/apideck_unify/models/accounting_billsupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .bill import BillInput, BillInputTypedDict +from .bill_input import BillInput, BillInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/accounting_creditnotesaddop.py b/src/apideck_unify/models/accounting_creditnotesaddop.py index 18562322..a8a57a5a 100644 --- a/src/apideck_unify/models/accounting_creditnotesaddop.py +++ b/src/apideck_unify/models/accounting_creditnotesaddop.py @@ -5,7 +5,7 @@ CreateCreditNoteResponse, CreateCreditNoteResponseTypedDict, ) -from .creditnote import CreditNoteInput, CreditNoteInputTypedDict +from .creditnote_input import CreditNoteInput, CreditNoteInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/accounting_creditnotesupdateop.py b/src/apideck_unify/models/accounting_creditnotesupdateop.py index 6a3125c5..92fc4d0a 100644 --- a/src/apideck_unify/models/accounting_creditnotesupdateop.py +++ b/src/apideck_unify/models/accounting_creditnotesupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .creditnote import CreditNoteInput, CreditNoteInputTypedDict +from .creditnote_input import CreditNoteInput, CreditNoteInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/accounting_departmentsaddop.py b/src/apideck_unify/models/accounting_departmentsaddop.py index b3bb8cc1..a9a71a6e 100644 --- a/src/apideck_unify/models/accounting_departmentsaddop.py +++ b/src/apideck_unify/models/accounting_departmentsaddop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .accountingdepartment import ( +from .accountingdepartment_input import ( AccountingDepartmentInput, AccountingDepartmentInputTypedDict, ) diff --git a/src/apideck_unify/models/accounting_departmentsupdateop.py b/src/apideck_unify/models/accounting_departmentsupdateop.py index 8a814c40..ea990c45 100644 --- a/src/apideck_unify/models/accounting_departmentsupdateop.py +++ b/src/apideck_unify/models/accounting_departmentsupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .accountingdepartment import ( +from .accountingdepartment_input import ( AccountingDepartmentInput, AccountingDepartmentInputTypedDict, ) diff --git a/src/apideck_unify/models/accounting_ledgeraccountsaddop.py b/src/apideck_unify/models/accounting_ledgeraccountsaddop.py index 53e4df86..e228438f 100644 --- a/src/apideck_unify/models/accounting_ledgeraccountsaddop.py +++ b/src/apideck_unify/models/accounting_ledgeraccountsaddop.py @@ -6,7 +6,7 @@ CreateLedgerAccountResponseTypedDict, ) from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .ledgeraccount import LedgerAccountInput, LedgerAccountInputTypedDict +from .ledgeraccount_input import LedgerAccountInput, LedgerAccountInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py b/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py index 556c1597..b10f29e2 100644 --- a/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py +++ b/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py @@ -2,7 +2,7 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .ledgeraccount import LedgerAccountInput, LedgerAccountInputTypedDict +from .ledgeraccount_input import LedgerAccountInput, LedgerAccountInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_purchaseordersaddop.py b/src/apideck_unify/models/accounting_purchaseordersaddop.py index e8cbf1c7..7d2dc303 100644 --- a/src/apideck_unify/models/accounting_purchaseordersaddop.py +++ b/src/apideck_unify/models/accounting_purchaseordersaddop.py @@ -6,7 +6,7 @@ CreatePurchaseOrderResponseTypedDict, ) from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .purchaseorder import PurchaseOrderInput, PurchaseOrderInputTypedDict +from .purchaseorder_input import PurchaseOrderInput, PurchaseOrderInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_purchaseordersupdateop.py b/src/apideck_unify/models/accounting_purchaseordersupdateop.py index 99509f89..874afbea 100644 --- a/src/apideck_unify/models/accounting_purchaseordersupdateop.py +++ b/src/apideck_unify/models/accounting_purchaseordersupdateop.py @@ -2,7 +2,7 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .purchaseorder import PurchaseOrderInput, PurchaseOrderInputTypedDict +from .purchaseorder_input import PurchaseOrderInput, PurchaseOrderInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_subsidiariesaddop.py b/src/apideck_unify/models/accounting_subsidiariesaddop.py index 5dbfda4a..8175f2bf 100644 --- a/src/apideck_unify/models/accounting_subsidiariesaddop.py +++ b/src/apideck_unify/models/accounting_subsidiariesaddop.py @@ -6,7 +6,7 @@ CreateSubsidiaryResponseTypedDict, ) from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .subsidiary import SubsidiaryInput, SubsidiaryInputTypedDict +from .subsidiary_input import SubsidiaryInput, SubsidiaryInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_subsidiariesupdateop.py b/src/apideck_unify/models/accounting_subsidiariesupdateop.py index c58dff16..e34020cb 100644 --- a/src/apideck_unify/models/accounting_subsidiariesupdateop.py +++ b/src/apideck_unify/models/accounting_subsidiariesupdateop.py @@ -2,7 +2,7 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .subsidiary import SubsidiaryInput, SubsidiaryInputTypedDict +from .subsidiary_input import SubsidiaryInput, SubsidiaryInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_taxratesaddop.py b/src/apideck_unify/models/accounting_taxratesaddop.py index 0a0ec06d..154d397d 100644 --- a/src/apideck_unify/models/accounting_taxratesaddop.py +++ b/src/apideck_unify/models/accounting_taxratesaddop.py @@ -3,7 +3,7 @@ from __future__ import annotations from .createtaxrateresponse import CreateTaxRateResponse, CreateTaxRateResponseTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .taxrate import TaxRateInput, TaxRateInputTypedDict +from .taxrate_input import TaxRateInput, TaxRateInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_taxratesupdateop.py b/src/apideck_unify/models/accounting_taxratesupdateop.py index c81edd7f..4fdd47a4 100644 --- a/src/apideck_unify/models/accounting_taxratesupdateop.py +++ b/src/apideck_unify/models/accounting_taxratesupdateop.py @@ -2,7 +2,7 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .taxrate import TaxRateInput, TaxRateInputTypedDict +from .taxrate_input import TaxRateInput, TaxRateInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_trackingcategoriesaddop.py b/src/apideck_unify/models/accounting_trackingcategoriesaddop.py index 6108e1c7..5d1282a1 100644 --- a/src/apideck_unify/models/accounting_trackingcategoriesaddop.py +++ b/src/apideck_unify/models/accounting_trackingcategoriesaddop.py @@ -6,7 +6,10 @@ CreateTrackingCategoryResponseTypedDict, ) from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .trackingcategory import TrackingCategoryInput, TrackingCategoryInputTypedDict +from .trackingcategory_input import ( + TrackingCategoryInput, + TrackingCategoryInputTypedDict, +) from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py b/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py index 4ac1abca..90cedb17 100644 --- a/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py +++ b/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py @@ -2,7 +2,10 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .trackingcategory import TrackingCategoryInput, TrackingCategoryInputTypedDict +from .trackingcategory_input import ( + TrackingCategoryInput, + TrackingCategoryInputTypedDict, +) from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/accountingdepartment.py b/src/apideck_unify/models/accountingdepartment_input.py similarity index 100% rename from src/apideck_unify/models/accountingdepartment.py rename to src/apideck_unify/models/accountingdepartment_input.py index f6f2b58e..f4bd3fa9 100644 --- a/src/apideck_unify/models/accountingdepartment.py +++ b/src/apideck_unify/models/accountingdepartment_input.py @@ -29,36 +29,21 @@ class DepartmentStatus(str, Enum): INACTIVE = "inactive" -class AccountingDepartmentTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" +class AccountingDepartmentInputTypedDict(TypedDict): parent_id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" name: NotRequired[Nullable[str]] r"""The name of the department.""" status: NotRequired[DepartmentStatus] r"""Based on the status some functionality is enabled or disabled.""" - subsidiaries: NotRequired[List[SubsidiaryReferenceTypedDict]] - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" + subsidiaries: NotRequired[List[SubsidiaryReferenceInputTypedDict]] row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class AccountingDepartment(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - +class AccountingDepartmentInput(BaseModel): parent_id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" @@ -68,55 +53,25 @@ class AccountingDepartment(BaseModel): status: Optional[DepartmentStatus] = None r"""Based on the status some functionality is enabled or disabled.""" - subsidiaries: Optional[List[SubsidiaryReference]] = None - - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" + subsidiaries: Optional[List[SubsidiaryReferenceInput]] = None row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", "parent_id", "name", "status", "subsidiaries", - "custom_mappings", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", ] - nullable_fields = [ - "parent_id", - "name", - "custom_mappings", - "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", - ] + nullable_fields = ["parent_id", "name", "row_version"] null_default_fields = [] serialized = handler(self) @@ -144,21 +99,36 @@ def serialize_model(self, handler): return m -class AccountingDepartmentInputTypedDict(TypedDict): +class AccountingDepartmentTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" parent_id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" name: NotRequired[Nullable[str]] r"""The name of the department.""" status: NotRequired[DepartmentStatus] r"""Based on the status some functionality is enabled or disabled.""" - subsidiaries: NotRequired[List[SubsidiaryReferenceInputTypedDict]] + subsidiaries: NotRequired[List[SubsidiaryReferenceTypedDict]] + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class AccountingDepartmentInput(BaseModel): +class AccountingDepartment(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + parent_id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" @@ -168,25 +138,55 @@ class AccountingDepartmentInput(BaseModel): status: Optional[DepartmentStatus] = None r"""Based on the status some functionality is enabled or disabled.""" - subsidiaries: Optional[List[SubsidiaryReferenceInput]] = None + subsidiaries: Optional[List[SubsidiaryReference]] = None + + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", "parent_id", "name", "status", "subsidiaries", + "custom_mappings", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", ] - nullable_fields = ["parent_id", "name", "row_version"] + nullable_fields = [ + "parent_id", + "name", + "custom_mappings", + "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", + ] null_default_fields = [] serialized = handler(self) diff --git a/src/apideck_unify/models/activity.py b/src/apideck_unify/models/activity_input.py similarity index 99% rename from src/apideck_unify/models/activity.py rename to src/apideck_unify/models/activity_input.py index 7447624a..bfc20c88 100644 --- a/src/apideck_unify/models/activity.py +++ b/src/apideck_unify/models/activity_input.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .activityattendee import ( +from .activityattendee_input import ( ActivityAttendee, ActivityAttendeeInput, ActivityAttendeeInputTypedDict, @@ -43,13 +43,9 @@ class ShowAs(str, Enum): BUSY = "busy" -class ActivityTypedDict(TypedDict): +class ActivityInputTypedDict(TypedDict): type: Nullable[ActivityType] r"""The type of the activity""" - id: NotRequired[str] - r"""The unique identifier of the activity""" - downstream_id: NotRequired[Nullable[str]] - r"""The third-party API ID of original entity""" activity_datetime: NotRequired[Nullable[str]] r"""The date and time of the activity""" duration_seconds: NotRequired[Nullable[int]] @@ -114,8 +110,6 @@ class ActivityTypedDict(TypedDict): r"""The start date and time of the activity""" end_datetime: NotRequired[Nullable[str]] r"""The end date and time of the activity""" - duration_minutes: NotRequired[Nullable[int]] - r"""The duration of the activity in minutes""" activity_date: NotRequired[Nullable[str]] r"""The date of the activity""" end_date: NotRequired[Nullable[str]] @@ -132,31 +126,15 @@ class ActivityTypedDict(TypedDict): r"""The ID of the video conference""" custom_fields: NotRequired[List[CustomFieldTypedDict]] r"""Custom fields of the activity""" - attendees: NotRequired[List[ActivityAttendeeTypedDict]] - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the activity""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the activity""" - updated_at: NotRequired[Nullable[str]] - r"""The date and time when the activity was last updated""" - created_at: NotRequired[Nullable[str]] - r"""The date and time when the activity was created""" + attendees: NotRequired[List[ActivityAttendeeInputTypedDict]] pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class Activity(BaseModel): +class ActivityInput(BaseModel): type: Nullable[ActivityType] r"""The type of the activity""" - id: Optional[str] = None - r"""The unique identifier of the activity""" - - downstream_id: OptionalNullable[str] = UNSET - r"""The third-party API ID of original entity""" - activity_datetime: OptionalNullable[str] = UNSET r"""The date and time of the activity""" @@ -254,9 +232,6 @@ class Activity(BaseModel): end_datetime: OptionalNullable[str] = UNSET r"""The end date and time of the activity""" - duration_minutes: OptionalNullable[int] = UNSET - r"""The duration of the activity in minutes""" - activity_date: OptionalNullable[str] = UNSET r"""The date of the activity""" @@ -281,22 +256,7 @@ class Activity(BaseModel): custom_fields: Optional[List[CustomField]] = None r"""Custom fields of the activity""" - attendees: Optional[List[ActivityAttendee]] = None - - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the activity""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the activity""" - - updated_at: OptionalNullable[str] = UNSET - r"""The date and time when the activity was last updated""" - - created_at: OptionalNullable[str] = UNSET - r"""The date and time when the activity was created""" + attendees: Optional[List[ActivityAttendeeInput]] = None pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -304,8 +264,6 @@ class Activity(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", - "downstream_id", "activity_datetime", "duration_seconds", "user_id", @@ -339,7 +297,6 @@ def serialize_model(self, handler): "done", "start_datetime", "end_datetime", - "duration_minutes", "activity_date", "end_date", "recurrent", @@ -349,16 +306,9 @@ def serialize_model(self, handler): "video_conference_id", "custom_fields", "attendees", - "custom_mappings", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", ] nullable_fields = [ - "type", - "downstream_id", "activity_datetime", "duration_seconds", "user_id", @@ -375,6 +325,7 @@ def serialize_model(self, handler): "product_id", "solution_id", "custom_object_id", + "type", "title", "description", "note", @@ -391,18 +342,12 @@ def serialize_model(self, handler): "done", "start_datetime", "end_datetime", - "duration_minutes", "activity_date", "end_date", "reminder_datetime", "reminder_set", "video_conference_url", "video_conference_id", - "custom_mappings", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -431,9 +376,13 @@ def serialize_model(self, handler): return m -class ActivityInputTypedDict(TypedDict): +class ActivityTypedDict(TypedDict): type: Nullable[ActivityType] r"""The type of the activity""" + id: NotRequired[str] + r"""The unique identifier of the activity""" + downstream_id: NotRequired[Nullable[str]] + r"""The third-party API ID of original entity""" activity_datetime: NotRequired[Nullable[str]] r"""The date and time of the activity""" duration_seconds: NotRequired[Nullable[int]] @@ -498,6 +447,8 @@ class ActivityInputTypedDict(TypedDict): r"""The start date and time of the activity""" end_datetime: NotRequired[Nullable[str]] r"""The end date and time of the activity""" + duration_minutes: NotRequired[Nullable[int]] + r"""The duration of the activity in minutes""" activity_date: NotRequired[Nullable[str]] r"""The date of the activity""" end_date: NotRequired[Nullable[str]] @@ -514,15 +465,31 @@ class ActivityInputTypedDict(TypedDict): r"""The ID of the video conference""" custom_fields: NotRequired[List[CustomFieldTypedDict]] r"""Custom fields of the activity""" - attendees: NotRequired[List[ActivityAttendeeInputTypedDict]] + attendees: NotRequired[List[ActivityAttendeeTypedDict]] + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the activity""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the activity""" + updated_at: NotRequired[Nullable[str]] + r"""The date and time when the activity was last updated""" + created_at: NotRequired[Nullable[str]] + r"""The date and time when the activity was created""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class ActivityInput(BaseModel): +class Activity(BaseModel): type: Nullable[ActivityType] r"""The type of the activity""" + id: Optional[str] = None + r"""The unique identifier of the activity""" + + downstream_id: OptionalNullable[str] = UNSET + r"""The third-party API ID of original entity""" + activity_datetime: OptionalNullable[str] = UNSET r"""The date and time of the activity""" @@ -620,6 +587,9 @@ class ActivityInput(BaseModel): end_datetime: OptionalNullable[str] = UNSET r"""The end date and time of the activity""" + duration_minutes: OptionalNullable[int] = UNSET + r"""The duration of the activity in minutes""" + activity_date: OptionalNullable[str] = UNSET r"""The date of the activity""" @@ -644,7 +614,22 @@ class ActivityInput(BaseModel): custom_fields: Optional[List[CustomField]] = None r"""Custom fields of the activity""" - attendees: Optional[List[ActivityAttendeeInput]] = None + attendees: Optional[List[ActivityAttendee]] = None + + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the activity""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the activity""" + + updated_at: OptionalNullable[str] = UNSET + r"""The date and time when the activity was last updated""" + + created_at: OptionalNullable[str] = UNSET + r"""The date and time when the activity was created""" pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -652,6 +637,8 @@ class ActivityInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", + "downstream_id", "activity_datetime", "duration_seconds", "user_id", @@ -685,6 +672,7 @@ def serialize_model(self, handler): "done", "start_datetime", "end_datetime", + "duration_minutes", "activity_date", "end_date", "recurrent", @@ -694,10 +682,15 @@ def serialize_model(self, handler): "video_conference_id", "custom_fields", "attendees", + "custom_mappings", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", ] nullable_fields = [ - "type", + "downstream_id", "activity_datetime", "duration_seconds", "user_id", @@ -714,6 +707,7 @@ def serialize_model(self, handler): "product_id", "solution_id", "custom_object_id", + "type", "title", "description", "note", @@ -730,12 +724,18 @@ def serialize_model(self, handler): "done", "start_datetime", "end_datetime", + "duration_minutes", "activity_date", "end_date", "reminder_datetime", "reminder_set", "video_conference_url", "video_conference_id", + "custom_mappings", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/activityattendee.py b/src/apideck_unify/models/activityattendee_input.py similarity index 100% rename from src/apideck_unify/models/activityattendee.py rename to src/apideck_unify/models/activityattendee_input.py index 7ecc49cb..369bde00 100644 --- a/src/apideck_unify/models/activityattendee.py +++ b/src/apideck_unify/models/activityattendee_input.py @@ -22,9 +22,7 @@ class ActivityAttendeeStatus(str, Enum): DECLINED = "declined" -class ActivityAttendeeTypedDict(TypedDict): - id: NotRequired[Nullable[str]] - r"""Unique identifier for the attendee""" +class ActivityAttendeeInputTypedDict(TypedDict): name: NotRequired[Nullable[str]] r"""Full name of the attendee""" first_name: NotRequired[Nullable[str]] @@ -43,20 +41,9 @@ class ActivityAttendeeTypedDict(TypedDict): r"""Whether the attendee is the organizer of the activity""" status: NotRequired[Nullable[ActivityAttendeeStatus]] r"""Status of the attendee""" - user_id: NotRequired[Nullable[str]] - r"""The identifier for a related user""" - contact_id: NotRequired[Nullable[str]] - r"""The identifier for a related contact""" - updated_at: NotRequired[Nullable[datetime]] - r"""The last time the attendee was updated (ISO 8601)""" - created_at: NotRequired[Nullable[datetime]] - r"""The time the attendee was created (ISO 8601)""" - -class ActivityAttendee(BaseModel): - id: OptionalNullable[str] = UNSET - r"""Unique identifier for the attendee""" +class ActivityAttendeeInput(BaseModel): name: OptionalNullable[str] = UNSET r"""Full name of the attendee""" @@ -84,22 +71,9 @@ class ActivityAttendee(BaseModel): status: OptionalNullable[ActivityAttendeeStatus] = UNSET r"""Status of the attendee""" - user_id: OptionalNullable[str] = UNSET - r"""The identifier for a related user""" - - contact_id: OptionalNullable[str] = UNSET - r"""The identifier for a related contact""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The last time the attendee was updated (ISO 8601)""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The time the attendee was created (ISO 8601)""" - @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", "name", "first_name", "middle_name", @@ -109,13 +83,8 @@ def serialize_model(self, handler): "email_address", "is_organizer", "status", - "user_id", - "contact_id", - "updated_at", - "created_at", ] nullable_fields = [ - "id", "name", "first_name", "middle_name", @@ -125,10 +94,6 @@ def serialize_model(self, handler): "email_address", "is_organizer", "status", - "user_id", - "contact_id", - "updated_at", - "created_at", ] null_default_fields = [] @@ -157,7 +122,9 @@ def serialize_model(self, handler): return m -class ActivityAttendeeInputTypedDict(TypedDict): +class ActivityAttendeeTypedDict(TypedDict): + id: NotRequired[Nullable[str]] + r"""Unique identifier for the attendee""" name: NotRequired[Nullable[str]] r"""Full name of the attendee""" first_name: NotRequired[Nullable[str]] @@ -176,9 +143,20 @@ class ActivityAttendeeInputTypedDict(TypedDict): r"""Whether the attendee is the organizer of the activity""" status: NotRequired[Nullable[ActivityAttendeeStatus]] r"""Status of the attendee""" + user_id: NotRequired[Nullable[str]] + r"""The identifier for a related user""" + contact_id: NotRequired[Nullable[str]] + r"""The identifier for a related contact""" + updated_at: NotRequired[Nullable[datetime]] + r"""The last time the attendee was updated (ISO 8601)""" + created_at: NotRequired[Nullable[datetime]] + r"""The time the attendee was created (ISO 8601)""" -class ActivityAttendeeInput(BaseModel): +class ActivityAttendee(BaseModel): + id: OptionalNullable[str] = UNSET + r"""Unique identifier for the attendee""" + name: OptionalNullable[str] = UNSET r"""Full name of the attendee""" @@ -206,9 +184,22 @@ class ActivityAttendeeInput(BaseModel): status: OptionalNullable[ActivityAttendeeStatus] = UNSET r"""Status of the attendee""" + user_id: OptionalNullable[str] = UNSET + r"""The identifier for a related user""" + + contact_id: OptionalNullable[str] = UNSET + r"""The identifier for a related contact""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The last time the attendee was updated (ISO 8601)""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The time the attendee was created (ISO 8601)""" + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", "name", "first_name", "middle_name", @@ -218,8 +209,13 @@ def serialize_model(self, handler): "email_address", "is_organizer", "status", + "user_id", + "contact_id", + "updated_at", + "created_at", ] nullable_fields = [ + "id", "name", "first_name", "middle_name", @@ -229,6 +225,10 @@ def serialize_model(self, handler): "email_address", "is_organizer", "status", + "user_id", + "contact_id", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/allocation.py b/src/apideck_unify/models/allocation_input.py similarity index 100% rename from src/apideck_unify/models/allocation.py rename to src/apideck_unify/models/allocation_input.py index 9b946271..96f45e9a 100644 --- a/src/apideck_unify/models/allocation.py +++ b/src/apideck_unify/models/allocation_input.py @@ -28,27 +28,24 @@ class AllocationType(str, Enum): BILL = "bill" -class AllocationTypedDict(TypedDict): +class AllocationInputTypedDict(TypedDict): id: NotRequired[str] r"""Unique identifier of entity this payment should be attributed to.""" type: NotRequired[AllocationType] r"""Type of entity this payment should be attributed to.""" - code: NotRequired[str] amount: NotRequired[Nullable[float]] r"""Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.""" allocation_id: NotRequired[str] r"""Unique identifier of the allocation""" -class Allocation(BaseModel): +class AllocationInput(BaseModel): id: Optional[str] = None r"""Unique identifier of entity this payment should be attributed to.""" type: Optional[AllocationType] = None r"""Type of entity this payment should be attributed to.""" - code: Optional[str] = None - amount: OptionalNullable[float] = UNSET r"""Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.""" @@ -57,7 +54,7 @@ class Allocation(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["id", "type", "code", "amount", "allocation_id"] + optional_fields = ["id", "type", "amount", "allocation_id"] nullable_fields = ["amount"] null_default_fields = [] @@ -86,24 +83,27 @@ def serialize_model(self, handler): return m -class AllocationInputTypedDict(TypedDict): +class AllocationTypedDict(TypedDict): id: NotRequired[str] r"""Unique identifier of entity this payment should be attributed to.""" type: NotRequired[AllocationType] r"""Type of entity this payment should be attributed to.""" + code: NotRequired[str] amount: NotRequired[Nullable[float]] r"""Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.""" allocation_id: NotRequired[str] r"""Unique identifier of the allocation""" -class AllocationInput(BaseModel): +class Allocation(BaseModel): id: Optional[str] = None r"""Unique identifier of entity this payment should be attributed to.""" type: Optional[AllocationType] = None r"""Type of entity this payment should be attributed to.""" + code: Optional[str] = None + amount: OptionalNullable[float] = UNSET r"""Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.""" @@ -112,7 +112,7 @@ class AllocationInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["id", "type", "amount", "allocation_id"] + optional_fields = ["id", "type", "code", "amount", "allocation_id"] nullable_fields = ["amount"] null_default_fields = [] diff --git a/src/apideck_unify/models/applicant.py b/src/apideck_unify/models/applicant_input.py similarity index 100% rename from src/apideck_unify/models/applicant.py rename to src/apideck_unify/models/applicant_input.py index 172408d6..686013a2 100644 --- a/src/apideck_unify/models/applicant.py +++ b/src/apideck_unify/models/applicant_input.py @@ -131,9 +131,7 @@ def serialize_model(self, handler): return m -class ApplicantTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" +class ApplicantInputTypedDict(TypedDict): name: NotRequired[str] r"""The name of an applicant.""" first_name: NotRequired[Nullable[str]] @@ -147,7 +145,6 @@ class ApplicantTypedDict(TypedDict): birthday: NotRequired[Nullable[date]] r"""The date of birth of the person.""" cover_letter: NotRequired[str] - job_url: NotRequired[Nullable[str]] photo_url: NotRequired[Nullable[str]] r"""The URL of the photo of a person.""" headline: NotRequired[str] @@ -167,41 +164,19 @@ class ApplicantTypedDict(TypedDict): applications: NotRequired[Nullable[List[str]]] followers: NotRequired[Nullable[List[str]]] sources: NotRequired[Nullable[List[str]]] - source_id: NotRequired[str] confidential: NotRequired[bool] anonymized: NotRequired[bool] tags: NotRequired[Nullable[List[str]]] archived: NotRequired[Nullable[bool]] - last_interaction_at: NotRequired[Nullable[datetime]] owner_id: NotRequired[Nullable[str]] - sourced_by: NotRequired[Nullable[str]] - cv_url: NotRequired[str] record_url: NotRequired[Nullable[str]] - rejected_at: NotRequired[Nullable[datetime]] - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" deleted: NotRequired[Nullable[bool]] r"""Flag to indicate if the object is deleted.""" - deleted_by: NotRequired[Nullable[str]] - r"""The user who deleted the object.""" - deleted_at: NotRequired[Nullable[datetime]] - r"""The time at which the object was deleted.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class Applicant(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - +class ApplicantInput(BaseModel): name: Optional[str] = None r"""The name of an applicant.""" @@ -222,8 +197,6 @@ class Applicant(BaseModel): cover_letter: Optional[str] = None - job_url: OptionalNullable[str] = UNSET - photo_url: OptionalNullable[str] = UNSET r"""The URL of the photo of a person.""" @@ -259,8 +232,6 @@ class Applicant(BaseModel): sources: OptionalNullable[List[str]] = UNSET - source_id: Optional[str] = None - confidential: Optional[bool] = None anonymized: Optional[bool] = None @@ -269,49 +240,19 @@ class Applicant(BaseModel): archived: OptionalNullable[bool] = UNSET - last_interaction_at: OptionalNullable[datetime] = UNSET - owner_id: OptionalNullable[str] = UNSET - sourced_by: OptionalNullable[str] = UNSET - - cv_url: Optional[str] = None - record_url: OptionalNullable[str] = UNSET - rejected_at: OptionalNullable[datetime] = UNSET - - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - deleted: OptionalNullable[bool] = UNSET r"""Flag to indicate if the object is deleted.""" - deleted_by: OptionalNullable[str] = UNSET - r"""The user who deleted the object.""" - - deleted_at: OptionalNullable[datetime] = UNSET - r"""The time at which the object was deleted.""" - - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", "name", "first_name", "last_name", @@ -319,7 +260,6 @@ def serialize_model(self, handler): "initials", "birthday", "cover_letter", - "job_url", "photo_url", "headline", "title", @@ -336,25 +276,13 @@ def serialize_model(self, handler): "applications", "followers", "sources", - "source_id", "confidential", "anonymized", "tags", "archived", - "last_interaction_at", "owner_id", - "sourced_by", - "cv_url", "record_url", - "rejected_at", - "custom_mappings", "deleted", - "deleted_by", - "deleted_at", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", ] nullable_fields = [ @@ -363,7 +291,6 @@ def serialize_model(self, handler): "middle_name", "initials", "birthday", - "job_url", "photo_url", "title", "application_ids", @@ -372,19 +299,9 @@ def serialize_model(self, handler): "sources", "tags", "archived", - "last_interaction_at", "owner_id", - "sourced_by", "record_url", - "rejected_at", - "custom_mappings", "deleted", - "deleted_by", - "deleted_at", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -413,7 +330,9 @@ def serialize_model(self, handler): return m -class ApplicantInputTypedDict(TypedDict): +class ApplicantTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" name: NotRequired[str] r"""The name of an applicant.""" first_name: NotRequired[Nullable[str]] @@ -427,6 +346,7 @@ class ApplicantInputTypedDict(TypedDict): birthday: NotRequired[Nullable[date]] r"""The date of birth of the person.""" cover_letter: NotRequired[str] + job_url: NotRequired[Nullable[str]] photo_url: NotRequired[Nullable[str]] r"""The URL of the photo of a person.""" headline: NotRequired[str] @@ -446,19 +366,41 @@ class ApplicantInputTypedDict(TypedDict): applications: NotRequired[Nullable[List[str]]] followers: NotRequired[Nullable[List[str]]] sources: NotRequired[Nullable[List[str]]] + source_id: NotRequired[str] confidential: NotRequired[bool] anonymized: NotRequired[bool] tags: NotRequired[Nullable[List[str]]] archived: NotRequired[Nullable[bool]] + last_interaction_at: NotRequired[Nullable[datetime]] owner_id: NotRequired[Nullable[str]] + sourced_by: NotRequired[Nullable[str]] + cv_url: NotRequired[str] record_url: NotRequired[Nullable[str]] + rejected_at: NotRequired[Nullable[datetime]] + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" deleted: NotRequired[Nullable[bool]] r"""Flag to indicate if the object is deleted.""" + deleted_by: NotRequired[Nullable[str]] + r"""The user who deleted the object.""" + deleted_at: NotRequired[Nullable[datetime]] + r"""The time at which the object was deleted.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class ApplicantInput(BaseModel): +class Applicant(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + name: Optional[str] = None r"""The name of an applicant.""" @@ -479,6 +421,8 @@ class ApplicantInput(BaseModel): cover_letter: Optional[str] = None + job_url: OptionalNullable[str] = UNSET + photo_url: OptionalNullable[str] = UNSET r"""The URL of the photo of a person.""" @@ -514,6 +458,8 @@ class ApplicantInput(BaseModel): sources: OptionalNullable[List[str]] = UNSET + source_id: Optional[str] = None + confidential: Optional[bool] = None anonymized: Optional[bool] = None @@ -522,19 +468,49 @@ class ApplicantInput(BaseModel): archived: OptionalNullable[bool] = UNSET + last_interaction_at: OptionalNullable[datetime] = UNSET + owner_id: OptionalNullable[str] = UNSET + sourced_by: OptionalNullable[str] = UNSET + + cv_url: Optional[str] = None + record_url: OptionalNullable[str] = UNSET + rejected_at: OptionalNullable[datetime] = UNSET + + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + deleted: OptionalNullable[bool] = UNSET r"""Flag to indicate if the object is deleted.""" + deleted_by: OptionalNullable[str] = UNSET + r"""The user who deleted the object.""" + + deleted_at: OptionalNullable[datetime] = UNSET + r"""The time at which the object was deleted.""" + + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", "name", "first_name", "last_name", @@ -542,6 +518,7 @@ def serialize_model(self, handler): "initials", "birthday", "cover_letter", + "job_url", "photo_url", "headline", "title", @@ -558,13 +535,25 @@ def serialize_model(self, handler): "applications", "followers", "sources", + "source_id", "confidential", "anonymized", "tags", "archived", + "last_interaction_at", "owner_id", + "sourced_by", + "cv_url", "record_url", + "rejected_at", + "custom_mappings", "deleted", + "deleted_by", + "deleted_at", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", ] nullable_fields = [ @@ -573,6 +562,7 @@ def serialize_model(self, handler): "middle_name", "initials", "birthday", + "job_url", "photo_url", "title", "application_ids", @@ -581,9 +571,19 @@ def serialize_model(self, handler): "sources", "tags", "archived", + "last_interaction_at", "owner_id", + "sourced_by", "record_url", + "rejected_at", + "custom_mappings", "deleted", + "deleted_by", + "deleted_at", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/application.py b/src/apideck_unify/models/application_input.py similarity index 100% rename from src/apideck_unify/models/application.py rename to src/apideck_unify/models/application_input.py index 315995a9..fc3fbce0 100644 --- a/src/apideck_unify/models/application.py +++ b/src/apideck_unify/models/application_input.py @@ -68,6 +68,58 @@ def serialize_model(self, handler): return m +class ApplicationInputTypedDict(TypedDict): + applicant_id: Nullable[str] + job_id: Nullable[str] + status: NotRequired[Nullable[ApplicationStatus]] + stage: NotRequired[StageTypedDict] + pass_through: NotRequired[List[PassThroughBodyTypedDict]] + r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" + + +class ApplicationInput(BaseModel): + applicant_id: Nullable[str] + + job_id: Nullable[str] + + status: OptionalNullable[ApplicationStatus] = UNSET + + stage: Optional[Stage] = None + + pass_through: Optional[List[PassThroughBody]] = None + r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["status", "stage", "pass_through"] + nullable_fields = ["applicant_id", "job_id", "status"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + class ApplicationTypedDict(TypedDict): applicant_id: Nullable[str] job_id: Nullable[str] @@ -167,55 +219,3 @@ def serialize_model(self, handler): m[k] = val return m - - -class ApplicationInputTypedDict(TypedDict): - applicant_id: Nullable[str] - job_id: Nullable[str] - status: NotRequired[Nullable[ApplicationStatus]] - stage: NotRequired[StageTypedDict] - pass_through: NotRequired[List[PassThroughBodyTypedDict]] - r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" - - -class ApplicationInput(BaseModel): - applicant_id: Nullable[str] - - job_id: Nullable[str] - - status: OptionalNullable[ApplicationStatus] = UNSET - - stage: Optional[Stage] = None - - pass_through: Optional[List[PassThroughBody]] = None - r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = ["status", "stage", "pass_through"] - nullable_fields = ["applicant_id", "job_id", "status"] - null_default_fields = [] - - serialized = handler(self) - - m = {} - - for n, f in type(self).model_fields.items(): - k = f.alias or n - val = serialized.get(k) - serialized.pop(k, None) - - optional_nullable = k in optional_fields and k in nullable_fields - is_set = ( - self.__pydantic_fields_set__.intersection({n}) - or k in null_default_fields - ) # pylint: disable=no-member - - if val is not None and val != UNSET_SENTINEL: - m[k] = val - elif val != UNSET_SENTINEL and ( - not k in optional_fields or (optional_nullable and is_set) - ): - m[k] = val - - return m diff --git a/src/apideck_unify/models/ats_applicantsaddop.py b/src/apideck_unify/models/ats_applicantsaddop.py index a3e6df5b..39093586 100644 --- a/src/apideck_unify/models/ats_applicantsaddop.py +++ b/src/apideck_unify/models/ats_applicantsaddop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .applicant import ApplicantInput, ApplicantInputTypedDict +from .applicant_input import ApplicantInput, ApplicantInputTypedDict from .createapplicantresponse import ( CreateApplicantResponse, CreateApplicantResponseTypedDict, diff --git a/src/apideck_unify/models/ats_applicantsupdateop.py b/src/apideck_unify/models/ats_applicantsupdateop.py index 520d4804..878d055d 100644 --- a/src/apideck_unify/models/ats_applicantsupdateop.py +++ b/src/apideck_unify/models/ats_applicantsupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .applicant import ApplicantInput, ApplicantInputTypedDict +from .applicant_input import ApplicantInput, ApplicantInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/ats_applicationsaddop.py b/src/apideck_unify/models/ats_applicationsaddop.py index 84999be6..5d951e01 100644 --- a/src/apideck_unify/models/ats_applicationsaddop.py +++ b/src/apideck_unify/models/ats_applicationsaddop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .application import ApplicationInput, ApplicationInputTypedDict +from .application_input import ApplicationInput, ApplicationInputTypedDict from .createapplicationresponse import ( CreateApplicationResponse, CreateApplicationResponseTypedDict, diff --git a/src/apideck_unify/models/ats_applicationsupdateop.py b/src/apideck_unify/models/ats_applicationsupdateop.py index 1dd2b772..818d3be4 100644 --- a/src/apideck_unify/models/ats_applicationsupdateop.py +++ b/src/apideck_unify/models/ats_applicationsupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .application import ApplicationInput, ApplicationInputTypedDict +from .application_input import ApplicationInput, ApplicationInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/bill.py b/src/apideck_unify/models/bill_input.py similarity index 100% rename from src/apideck_unify/models/bill.py rename to src/apideck_unify/models/bill_input.py index ca480e8a..b9c98ae3 100644 --- a/src/apideck_unify/models/bill.py +++ b/src/apideck_unify/models/bill_input.py @@ -50,14 +50,10 @@ class BillStatus(str, Enum): DELETED = "deleted" -class BillTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" - downstream_id: NotRequired[Nullable[str]] - r"""The third-party API ID of original entity""" +class BillInputTypedDict(TypedDict): bill_number: NotRequired[Nullable[str]] r"""Reference to supplier bill number""" - supplier: NotRequired[Nullable[LinkedSupplierTypedDict]] + supplier: NotRequired[Nullable[LinkedSupplierInputTypedDict]] r"""The supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] r"""The company or subsidiary id the transaction belongs to""" @@ -77,7 +73,7 @@ class BillTypedDict(TypedDict): r"""A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.""" reference: NotRequired[Nullable[str]] r"""Optional bill reference.""" - line_items: NotRequired[List[BillLineItemTypedDict]] + line_items: NotRequired[List[BillLineItemInputTypedDict]] terms: NotRequired[Nullable[str]] r"""Terms of payment.""" balance: NotRequired[Nullable[float]] @@ -95,7 +91,7 @@ class BillTypedDict(TypedDict): notes: NotRequired[Nullable[str]] status: NotRequired[Nullable[BillStatus]] r"""Invoice status""" - ledger_account: NotRequired[Nullable[LinkedLedgerAccountTypedDict]] + ledger_account: NotRequired[Nullable[LinkedLedgerAccountInputTypedDict]] payment_method: NotRequired[Nullable[str]] r"""Payment method used for the transaction, such as cash, credit card, bank transfer, or check""" channel: NotRequired[Nullable[str]] @@ -113,36 +109,20 @@ class BillTypedDict(TypedDict): Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] ] r"""A list of linked tracking categories.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" accounting_period: NotRequired[Nullable[str]] r"""Accounting period""" -class Bill(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - - downstream_id: OptionalNullable[str] = UNSET - r"""The third-party API ID of original entity""" - +class BillInput(BaseModel): bill_number: OptionalNullable[str] = UNSET r"""Reference to supplier bill number""" - supplier: OptionalNullable[LinkedSupplier] = UNSET + supplier: OptionalNullable[LinkedSupplierInput] = UNSET r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET @@ -172,7 +152,7 @@ class Bill(BaseModel): reference: OptionalNullable[str] = UNSET r"""Optional bill reference.""" - line_items: Optional[List[BillLineItem]] = None + line_items: Optional[List[BillLineItemInput]] = None terms: OptionalNullable[str] = UNSET r"""Terms of payment.""" @@ -200,7 +180,7 @@ class Bill(BaseModel): status: OptionalNullable[BillStatus] = UNSET r"""Invoice status""" - ledger_account: OptionalNullable[LinkedLedgerAccount] = UNSET + ledger_account: OptionalNullable[LinkedLedgerAccountInput] = UNSET payment_method: OptionalNullable[str] = UNSET r"""Payment method used for the transaction, such as cash, credit card, bank transfer, or check""" @@ -227,26 +207,11 @@ class Bill(BaseModel): ) r"""A list of linked tracking categories.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" custom_fields: Optional[List[CustomField]] = None - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -256,8 +221,6 @@ class Bill(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", - "downstream_id", "bill_number", "supplier", "company_id", @@ -288,18 +251,12 @@ def serialize_model(self, handler): "discount_percentage", "source_document_url", "tracking_categories", - "updated_by", - "created_by", - "updated_at", - "created_at", "row_version", "custom_fields", - "custom_mappings", "pass_through", "accounting_period", ] nullable_fields = [ - "downstream_id", "bill_number", "supplier", "company_id", @@ -328,12 +285,7 @@ def serialize_model(self, handler): "discount_percentage", "source_document_url", "tracking_categories", - "updated_by", - "created_by", - "updated_at", - "created_at", "row_version", - "custom_mappings", "accounting_period", ] null_default_fields = [] @@ -363,10 +315,14 @@ def serialize_model(self, handler): return m -class BillInputTypedDict(TypedDict): +class BillTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" + downstream_id: NotRequired[Nullable[str]] + r"""The third-party API ID of original entity""" bill_number: NotRequired[Nullable[str]] r"""Reference to supplier bill number""" - supplier: NotRequired[Nullable[LinkedSupplierInputTypedDict]] + supplier: NotRequired[Nullable[LinkedSupplierTypedDict]] r"""The supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] r"""The company or subsidiary id the transaction belongs to""" @@ -386,7 +342,7 @@ class BillInputTypedDict(TypedDict): r"""A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.""" reference: NotRequired[Nullable[str]] r"""Optional bill reference.""" - line_items: NotRequired[List[BillLineItemInputTypedDict]] + line_items: NotRequired[List[BillLineItemTypedDict]] terms: NotRequired[Nullable[str]] r"""Terms of payment.""" balance: NotRequired[Nullable[float]] @@ -404,7 +360,7 @@ class BillInputTypedDict(TypedDict): notes: NotRequired[Nullable[str]] status: NotRequired[Nullable[BillStatus]] r"""Invoice status""" - ledger_account: NotRequired[Nullable[LinkedLedgerAccountInputTypedDict]] + ledger_account: NotRequired[Nullable[LinkedLedgerAccountTypedDict]] payment_method: NotRequired[Nullable[str]] r"""Payment method used for the transaction, such as cash, credit card, bank transfer, or check""" channel: NotRequired[Nullable[str]] @@ -422,20 +378,36 @@ class BillInputTypedDict(TypedDict): Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] ] r"""A list of linked tracking categories.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" accounting_period: NotRequired[Nullable[str]] r"""Accounting period""" -class BillInput(BaseModel): +class Bill(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + + downstream_id: OptionalNullable[str] = UNSET + r"""The third-party API ID of original entity""" + bill_number: OptionalNullable[str] = UNSET r"""Reference to supplier bill number""" - supplier: OptionalNullable[LinkedSupplierInput] = UNSET + supplier: OptionalNullable[LinkedSupplier] = UNSET r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET @@ -465,7 +437,7 @@ class BillInput(BaseModel): reference: OptionalNullable[str] = UNSET r"""Optional bill reference.""" - line_items: Optional[List[BillLineItemInput]] = None + line_items: Optional[List[BillLineItem]] = None terms: OptionalNullable[str] = UNSET r"""Terms of payment.""" @@ -493,7 +465,7 @@ class BillInput(BaseModel): status: OptionalNullable[BillStatus] = UNSET r"""Invoice status""" - ledger_account: OptionalNullable[LinkedLedgerAccountInput] = UNSET + ledger_account: OptionalNullable[LinkedLedgerAccount] = UNSET payment_method: OptionalNullable[str] = UNSET r"""Payment method used for the transaction, such as cash, credit card, bank transfer, or check""" @@ -520,11 +492,26 @@ class BillInput(BaseModel): ) r"""A list of linked tracking categories.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" custom_fields: Optional[List[CustomField]] = None + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -534,6 +521,8 @@ class BillInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", + "downstream_id", "bill_number", "supplier", "company_id", @@ -564,12 +553,18 @@ def serialize_model(self, handler): "discount_percentage", "source_document_url", "tracking_categories", + "updated_by", + "created_by", + "updated_at", + "created_at", "row_version", "custom_fields", + "custom_mappings", "pass_through", "accounting_period", ] nullable_fields = [ + "downstream_id", "bill_number", "supplier", "company_id", @@ -598,7 +593,12 @@ def serialize_model(self, handler): "discount_percentage", "source_document_url", "tracking_categories", + "updated_by", + "created_by", + "updated_at", + "created_at", "row_version", + "custom_mappings", "accounting_period", ] null_default_fields = [] diff --git a/src/apideck_unify/models/billpayment.py b/src/apideck_unify/models/billpayment.py index 84f429c1..10a6d60d 100644 --- a/src/apideck_unify/models/billpayment.py +++ b/src/apideck_unify/models/billpayment.py @@ -288,16 +288,16 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ - "total_amount", - "transaction_date", "downstream_id", "currency", "currency_rate", + "total_amount", "reference", "payment_method", "payment_method_reference", "payment_method_id", "account", + "transaction_date", "supplier", "company_id", "reconciled", @@ -531,15 +531,15 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ - "total_amount", - "transaction_date", "currency", "currency_rate", + "total_amount", "reference", "payment_method", "payment_method_reference", "payment_method_id", "account", + "transaction_date", "supplier", "company_id", "reconciled", diff --git a/src/apideck_unify/models/companyinfo.py b/src/apideck_unify/models/companyinfo.py index 4582c1dd..f0b49de3 100644 --- a/src/apideck_unify/models/companyinfo.py +++ b/src/apideck_unify/models/companyinfo.py @@ -6,7 +6,7 @@ from .custommappings import CustomMappings, CustomMappingsTypedDict from .email import Email, EmailTypedDict from .phonenumber import PhoneNumber, PhoneNumberTypedDict -from .taxrate import TaxRate, TaxRateTypedDict +from .taxrate_input import TaxRate, TaxRateTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/connection.py b/src/apideck_unify/models/connection_input.py similarity index 100% rename from src/apideck_unify/models/connection.py rename to src/apideck_unify/models/connection_input.py index 27db2dd4..34a4112d 100644 --- a/src/apideck_unify/models/connection.py +++ b/src/apideck_unify/models/connection_input.py @@ -23,19 +23,6 @@ from typing_extensions import NotRequired, TypeAliasType, TypedDict -class ConnectionStatus(str, Enum): - r"""Status of the connection.""" - - LIVE = "live" - UPCOMING = "upcoming" - REQUESTED = "requested" - - -class Target(str, Enum): - CUSTOM_FIELDS = "custom_fields" - RESOURCE = "resource" - - Value5TypedDict = TypeAliasType("Value5TypedDict", Union[str, int, float]) @@ -52,6 +39,108 @@ class Target(str, Enum): ) +class ConnectionDefaultsTypedDict(TypedDict): + id: NotRequired[str] + options: NotRequired[List[FormFieldOptionTypedDict]] + value: NotRequired[ConnectionValueTypedDict] + + +class ConnectionDefaults(BaseModel): + id: Optional[str] = None + + options: Optional[List[FormFieldOption]] = None + + value: Optional[ConnectionValue] = None + + +class ConnectionConfigurationTypedDict(TypedDict): + resource: NotRequired[str] + defaults: NotRequired[List[ConnectionDefaultsTypedDict]] + + +class ConnectionConfiguration(BaseModel): + resource: Optional[str] = None + + defaults: Optional[List[ConnectionDefaults]] = None + + +class ConnectionInputTypedDict(TypedDict): + enabled: NotRequired[bool] + r"""Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.""" + settings: NotRequired[Nullable[Dict[str, Any]]] + r"""Connection settings. Values will persist to `form_fields` with corresponding id""" + metadata: NotRequired[Nullable[Dict[str, Any]]] + r"""Attach your own consumer specific metadata""" + configuration: NotRequired[List[ConnectionConfigurationTypedDict]] + custom_mappings: NotRequired[List[CustomMappingInputTypedDict]] + r"""List of custom mappings configured for this connection""" + + +class ConnectionInput(BaseModel): + enabled: Optional[bool] = None + r"""Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.""" + + settings: OptionalNullable[Dict[str, Any]] = UNSET + r"""Connection settings. Values will persist to `form_fields` with corresponding id""" + + metadata: OptionalNullable[Dict[str, Any]] = UNSET + r"""Attach your own consumer specific metadata""" + + configuration: Optional[List[ConnectionConfiguration]] = None + + custom_mappings: Optional[List[CustomMappingInput]] = None + r"""List of custom mappings configured for this connection""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "enabled", + "settings", + "metadata", + "configuration", + "custom_mappings", + ] + nullable_fields = ["settings", "metadata"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class ConnectionStatus(str, Enum): + r"""Status of the connection.""" + + LIVE = "live" + UPCOMING = "upcoming" + REQUESTED = "requested" + + +class Target(str, Enum): + CUSTOM_FIELDS = "custom_fields" + RESOURCE = "resource" + + class DefaultsTypedDict(TypedDict): target: NotRequired[Target] id: NotRequired[str] @@ -286,92 +375,3 @@ def serialize_model(self, handler): m[k] = val return m - - -class ConnectionDefaultsTypedDict(TypedDict): - id: NotRequired[str] - options: NotRequired[List[FormFieldOptionTypedDict]] - value: NotRequired[ConnectionValueTypedDict] - - -class ConnectionDefaults(BaseModel): - id: Optional[str] = None - - options: Optional[List[FormFieldOption]] = None - - value: Optional[ConnectionValue] = None - - -class ConnectionConfigurationTypedDict(TypedDict): - resource: NotRequired[str] - defaults: NotRequired[List[ConnectionDefaultsTypedDict]] - - -class ConnectionConfiguration(BaseModel): - resource: Optional[str] = None - - defaults: Optional[List[ConnectionDefaults]] = None - - -class ConnectionInputTypedDict(TypedDict): - enabled: NotRequired[bool] - r"""Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.""" - settings: NotRequired[Nullable[Dict[str, Any]]] - r"""Connection settings. Values will persist to `form_fields` with corresponding id""" - metadata: NotRequired[Nullable[Dict[str, Any]]] - r"""Attach your own consumer specific metadata""" - configuration: NotRequired[List[ConnectionConfigurationTypedDict]] - custom_mappings: NotRequired[List[CustomMappingInputTypedDict]] - r"""List of custom mappings configured for this connection""" - - -class ConnectionInput(BaseModel): - enabled: Optional[bool] = None - r"""Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.""" - - settings: OptionalNullable[Dict[str, Any]] = UNSET - r"""Connection settings. Values will persist to `form_fields` with corresponding id""" - - metadata: OptionalNullable[Dict[str, Any]] = UNSET - r"""Attach your own consumer specific metadata""" - - configuration: Optional[List[ConnectionConfiguration]] = None - - custom_mappings: Optional[List[CustomMappingInput]] = None - r"""List of custom mappings configured for this connection""" - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [ - "enabled", - "settings", - "metadata", - "configuration", - "custom_mappings", - ] - nullable_fields = ["settings", "metadata"] - null_default_fields = [] - - serialized = handler(self) - - m = {} - - for n, f in type(self).model_fields.items(): - k = f.alias or n - val = serialized.get(k) - serialized.pop(k, None) - - optional_nullable = k in optional_fields and k in nullable_fields - is_set = ( - self.__pydantic_fields_set__.intersection({n}) - or k in null_default_fields - ) # pylint: disable=no-member - - if val is not None and val != UNSET_SENTINEL: - m[k] = val - elif val != UNSET_SENTINEL and ( - not k in optional_fields or (optional_nullable and is_set) - ): - m[k] = val - - return m diff --git a/src/apideck_unify/models/contact.py b/src/apideck_unify/models/contact_input.py similarity index 100% rename from src/apideck_unify/models/contact.py rename to src/apideck_unify/models/contact_input.py index 01daf201..2cabbe0a 100644 --- a/src/apideck_unify/models/contact.py +++ b/src/apideck_unify/models/contact_input.py @@ -41,11 +41,9 @@ class ContactGender(str, Enum): UNISEX = "unisex" -class ContactTypedDict(TypedDict): +class ContactInputTypedDict(TypedDict): name: Nullable[str] r"""Full name of the contact.""" - id: NotRequired[str] - r"""Unique identifier for the contact.""" owner_id: NotRequired[Nullable[str]] r"""The owner of the contact.""" type: NotRequired[Nullable[ContactType]] @@ -99,31 +97,16 @@ class ContactTypedDict(TypedDict): email_domain: NotRequired[Nullable[str]] custom_fields: NotRequired[List[CustomFieldTypedDict]] tags: NotRequired[Nullable[List[str]]] - first_call_at: NotRequired[Nullable[datetime]] - r"""The first call date of the contact.""" - first_email_at: NotRequired[Nullable[datetime]] - r"""The first email date of the contact.""" - last_activity_at: NotRequired[Nullable[datetime]] - r"""The last activity date of the contact.""" - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The last update date of the contact.""" - created_at: NotRequired[Nullable[datetime]] - r"""The creation date of the contact.""" opportunity_ids: NotRequired[List[str]] r"""The opportunity ids of the contact.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class Contact(BaseModel): +class ContactInput(BaseModel): name: Nullable[str] r"""Full name of the contact.""" - id: Optional[str] = None - r"""Unique identifier for the contact.""" - owner_id: OptionalNullable[str] = UNSET r"""The owner of the contact.""" @@ -213,24 +196,6 @@ class Contact(BaseModel): tags: OptionalNullable[List[str]] = UNSET - first_call_at: OptionalNullable[datetime] = UNSET - r"""The first call date of the contact.""" - - first_email_at: OptionalNullable[datetime] = UNSET - r"""The first email date of the contact.""" - - last_activity_at: OptionalNullable[datetime] = UNSET - r"""The last activity date of the contact.""" - - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The last update date of the contact.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The creation date of the contact.""" - opportunity_ids: Optional[List[str]] = None r"""The opportunity ids of the contact.""" @@ -240,7 +205,6 @@ class Contact(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", "owner_id", "type", "company_id", @@ -272,12 +236,6 @@ def serialize_model(self, handler): "email_domain", "custom_fields", "tags", - "first_call_at", - "first_email_at", - "last_activity_at", - "custom_mappings", - "updated_at", - "created_at", "opportunity_ids", "pass_through", ] @@ -308,12 +266,6 @@ def serialize_model(self, handler): "active", "email_domain", "tags", - "first_call_at", - "first_email_at", - "last_activity_at", - "custom_mappings", - "updated_at", - "created_at", ] null_default_fields = [] @@ -342,9 +294,11 @@ def serialize_model(self, handler): return m -class ContactInputTypedDict(TypedDict): +class ContactTypedDict(TypedDict): name: Nullable[str] r"""Full name of the contact.""" + id: NotRequired[str] + r"""Unique identifier for the contact.""" owner_id: NotRequired[Nullable[str]] r"""The owner of the contact.""" type: NotRequired[Nullable[ContactType]] @@ -398,16 +352,31 @@ class ContactInputTypedDict(TypedDict): email_domain: NotRequired[Nullable[str]] custom_fields: NotRequired[List[CustomFieldTypedDict]] tags: NotRequired[Nullable[List[str]]] + first_call_at: NotRequired[Nullable[datetime]] + r"""The first call date of the contact.""" + first_email_at: NotRequired[Nullable[datetime]] + r"""The first email date of the contact.""" + last_activity_at: NotRequired[Nullable[datetime]] + r"""The last activity date of the contact.""" + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The last update date of the contact.""" + created_at: NotRequired[Nullable[datetime]] + r"""The creation date of the contact.""" opportunity_ids: NotRequired[List[str]] r"""The opportunity ids of the contact.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class ContactInput(BaseModel): +class Contact(BaseModel): name: Nullable[str] r"""Full name of the contact.""" + id: Optional[str] = None + r"""Unique identifier for the contact.""" + owner_id: OptionalNullable[str] = UNSET r"""The owner of the contact.""" @@ -497,6 +466,24 @@ class ContactInput(BaseModel): tags: OptionalNullable[List[str]] = UNSET + first_call_at: OptionalNullable[datetime] = UNSET + r"""The first call date of the contact.""" + + first_email_at: OptionalNullable[datetime] = UNSET + r"""The first email date of the contact.""" + + last_activity_at: OptionalNullable[datetime] = UNSET + r"""The last activity date of the contact.""" + + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The last update date of the contact.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The creation date of the contact.""" + opportunity_ids: Optional[List[str]] = None r"""The opportunity ids of the contact.""" @@ -506,6 +493,7 @@ class ContactInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", "owner_id", "type", "company_id", @@ -537,6 +525,12 @@ def serialize_model(self, handler): "email_domain", "custom_fields", "tags", + "first_call_at", + "first_email_at", + "last_activity_at", + "custom_mappings", + "updated_at", + "created_at", "opportunity_ids", "pass_through", ] @@ -567,6 +561,12 @@ def serialize_model(self, handler): "active", "email_domain", "tags", + "first_call_at", + "first_email_at", + "last_activity_at", + "custom_mappings", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/createconnectionresponse.py b/src/apideck_unify/models/createconnectionresponse.py index 39c79fa6..8b65e204 100644 --- a/src/apideck_unify/models/createconnectionresponse.py +++ b/src/apideck_unify/models/createconnectionresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .connection import Connection, ConnectionTypedDict +from .connection_input import Connection, ConnectionTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/creditnote.py b/src/apideck_unify/models/creditnote_input.py similarity index 99% rename from src/apideck_unify/models/creditnote.py rename to src/apideck_unify/models/creditnote_input.py index a3e2ab94..1feec4c1 100644 --- a/src/apideck_unify/models/creditnote.py +++ b/src/apideck_unify/models/creditnote_input.py @@ -2,7 +2,7 @@ from __future__ import annotations from .address import Address, AddressTypedDict -from .allocation import ( +from .allocation_input import ( Allocation, AllocationInput, AllocationInputTypedDict, @@ -60,14 +60,12 @@ class CreditNoteType(str, Enum): ACCOUNTS_PAYABLE_CREDIT = "accounts_payable_credit" -class CreditNoteTypedDict(TypedDict): - id: str - r"""Unique identifier representing the entity""" +class CreditNoteInputTypedDict(TypedDict): total_amount: float r"""Amount of transaction""" number: NotRequired[Nullable[str]] r"""Credit note number.""" - customer: NotRequired[Nullable[LinkedCustomerTypedDict]] + customer: NotRequired[Nullable[LinkedCustomerInputTypedDict]] r"""The customer this entity is linked to.""" company_id: NotRequired[Nullable[str]] r"""The company or subsidiary id the transaction belongs to""" @@ -97,9 +95,9 @@ class CreditNoteTypedDict(TypedDict): r"""Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD""" type: NotRequired[CreditNoteType] r"""Type of payment""" - account: NotRequired[Nullable[LinkedLedgerAccountTypedDict]] - line_items: NotRequired[List[InvoiceLineItemTypedDict]] - allocations: NotRequired[List[AllocationTypedDict]] + account: NotRequired[Nullable[LinkedLedgerAccountInputTypedDict]] + line_items: NotRequired[List[InvoiceLineItemInputTypedDict]] + allocations: NotRequired[List[AllocationInputTypedDict]] note: NotRequired[Nullable[str]] r"""Optional note to be associated with the credit note.""" terms: NotRequired[Nullable[str]] @@ -110,34 +108,21 @@ class CreditNoteTypedDict(TypedDict): Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] ] r"""A list of linked tracking categories.""" - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class CreditNote(BaseModel): - id: str - r"""Unique identifier representing the entity""" - +class CreditNoteInput(BaseModel): total_amount: float r"""Amount of transaction""" number: OptionalNullable[str] = UNSET r"""Credit note number.""" - customer: OptionalNullable[LinkedCustomer] = UNSET + customer: OptionalNullable[LinkedCustomerInput] = UNSET r"""The customer this entity is linked to.""" company_id: OptionalNullable[str] = UNSET @@ -182,11 +167,11 @@ class CreditNote(BaseModel): type: Optional[CreditNoteType] = None r"""Type of payment""" - account: OptionalNullable[LinkedLedgerAccount] = UNSET + account: OptionalNullable[LinkedLedgerAccountInput] = UNSET - line_items: Optional[List[InvoiceLineItem]] = None + line_items: Optional[List[InvoiceLineItemInput]] = None - allocations: Optional[List[Allocation]] = None + allocations: Optional[List[AllocationInput]] = None note: OptionalNullable[str] = UNSET r"""Optional note to be associated with the credit note.""" @@ -203,26 +188,11 @@ class CreditNote(BaseModel): ) r"""A list of linked tracking categories.""" - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - custom_fields: Optional[List[CustomField]] = None row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -253,13 +223,8 @@ def serialize_model(self, handler): "billing_address", "shipping_address", "tracking_categories", - "custom_mappings", "custom_fields", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", ] nullable_fields = [ @@ -280,12 +245,7 @@ def serialize_model(self, handler): "note", "terms", "tracking_categories", - "custom_mappings", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -314,12 +274,14 @@ def serialize_model(self, handler): return m -class CreditNoteInputTypedDict(TypedDict): +class CreditNoteTypedDict(TypedDict): + id: str + r"""Unique identifier representing the entity""" total_amount: float r"""Amount of transaction""" number: NotRequired[Nullable[str]] r"""Credit note number.""" - customer: NotRequired[Nullable[LinkedCustomerInputTypedDict]] + customer: NotRequired[Nullable[LinkedCustomerTypedDict]] r"""The customer this entity is linked to.""" company_id: NotRequired[Nullable[str]] r"""The company or subsidiary id the transaction belongs to""" @@ -349,9 +311,9 @@ class CreditNoteInputTypedDict(TypedDict): r"""Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD""" type: NotRequired[CreditNoteType] r"""Type of payment""" - account: NotRequired[Nullable[LinkedLedgerAccountInputTypedDict]] - line_items: NotRequired[List[InvoiceLineItemInputTypedDict]] - allocations: NotRequired[List[AllocationInputTypedDict]] + account: NotRequired[Nullable[LinkedLedgerAccountTypedDict]] + line_items: NotRequired[List[InvoiceLineItemTypedDict]] + allocations: NotRequired[List[AllocationTypedDict]] note: NotRequired[Nullable[str]] r"""Optional note to be associated with the credit note.""" terms: NotRequired[Nullable[str]] @@ -362,21 +324,34 @@ class CreditNoteInputTypedDict(TypedDict): Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] ] r"""A list of linked tracking categories.""" + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class CreditNoteInput(BaseModel): +class CreditNote(BaseModel): + id: str + r"""Unique identifier representing the entity""" + total_amount: float r"""Amount of transaction""" number: OptionalNullable[str] = UNSET r"""Credit note number.""" - customer: OptionalNullable[LinkedCustomerInput] = UNSET + customer: OptionalNullable[LinkedCustomer] = UNSET r"""The customer this entity is linked to.""" company_id: OptionalNullable[str] = UNSET @@ -421,11 +396,11 @@ class CreditNoteInput(BaseModel): type: Optional[CreditNoteType] = None r"""Type of payment""" - account: OptionalNullable[LinkedLedgerAccountInput] = UNSET + account: OptionalNullable[LinkedLedgerAccount] = UNSET - line_items: Optional[List[InvoiceLineItemInput]] = None + line_items: Optional[List[InvoiceLineItem]] = None - allocations: Optional[List[AllocationInput]] = None + allocations: Optional[List[Allocation]] = None note: OptionalNullable[str] = UNSET r"""Optional note to be associated with the credit note.""" @@ -442,11 +417,26 @@ class CreditNoteInput(BaseModel): ) r"""A list of linked tracking categories.""" + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + custom_fields: Optional[List[CustomField]] = None row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -477,8 +467,13 @@ def serialize_model(self, handler): "billing_address", "shipping_address", "tracking_categories", + "custom_mappings", "custom_fields", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", ] nullable_fields = [ @@ -499,7 +494,12 @@ def serialize_model(self, handler): "note", "terms", "tracking_categories", + "custom_mappings", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_activitiesaddop.py b/src/apideck_unify/models/crm_activitiesaddop.py index e31da405..7c6fdd47 100644 --- a/src/apideck_unify/models/crm_activitiesaddop.py +++ b/src/apideck_unify/models/crm_activitiesaddop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .activity import ActivityInput, ActivityInputTypedDict +from .activity_input import ActivityInput, ActivityInputTypedDict from .createactivityresponse import ( CreateActivityResponse, CreateActivityResponseTypedDict, diff --git a/src/apideck_unify/models/crm_activitiesupdateop.py b/src/apideck_unify/models/crm_activitiesupdateop.py index f2a3faac..8d1c5592 100644 --- a/src/apideck_unify/models/crm_activitiesupdateop.py +++ b/src/apideck_unify/models/crm_activitiesupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .activity import ActivityInput, ActivityInputTypedDict +from .activity_input import ActivityInput, ActivityInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/crm_contactsaddop.py b/src/apideck_unify/models/crm_contactsaddop.py index 796e29dd..0b6193ae 100644 --- a/src/apideck_unify/models/crm_contactsaddop.py +++ b/src/apideck_unify/models/crm_contactsaddop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .contact import ContactInput, ContactInputTypedDict +from .contact_input import ContactInput, ContactInputTypedDict from .createcontactresponse import CreateContactResponse, CreateContactResponseTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( diff --git a/src/apideck_unify/models/crm_contactsupdateop.py b/src/apideck_unify/models/crm_contactsupdateop.py index b6d00100..4cf8f321 100644 --- a/src/apideck_unify/models/crm_contactsupdateop.py +++ b/src/apideck_unify/models/crm_contactsupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .contact import ContactInput, ContactInputTypedDict +from .contact_input import ContactInput, ContactInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/ecommerceorderlineitem.py b/src/apideck_unify/models/ecommerceorderlineitem.py index 5f0a7869..c7bf4f7c 100644 --- a/src/apideck_unify/models/ecommerceorderlineitem.py +++ b/src/apideck_unify/models/ecommerceorderlineitem.py @@ -172,14 +172,13 @@ def serialize_model(self, handler): "discounts", ] nullable_fields = [ - "name", - "quantity", - "total_amount", "id", "product_id", "variant_id", "sku", + "name", "description", + "quantity", "unit_price", "tax_rate", "tax_amount", @@ -187,6 +186,7 @@ def serialize_model(self, handler): "refunded_amount", "refunded_quantity", "sub_total", + "total_amount", ] null_default_fields = [] diff --git a/src/apideck_unify/models/email.py b/src/apideck_unify/models/email.py index ed481a26..957b0a62 100644 --- a/src/apideck_unify/models/email.py +++ b/src/apideck_unify/models/email.py @@ -46,7 +46,7 @@ class Email(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["id", "type"] - nullable_fields = ["email", "id", "type"] + nullable_fields = ["id", "email", "type"] null_default_fields = [] serialized = handler(self) diff --git a/src/apideck_unify/models/employee.py b/src/apideck_unify/models/employee_input.py similarity index 99% rename from src/apideck_unify/models/employee.py rename to src/apideck_unify/models/employee_input.py index 265e5925..7f38bbec 100644 --- a/src/apideck_unify/models/employee.py +++ b/src/apideck_unify/models/employee_input.py @@ -12,7 +12,7 @@ EmployeeCompensationInputTypedDict, EmployeeCompensationTypedDict, ) -from .employeejob import ( +from .employeejob_input import ( EmployeeJob, EmployeeJobInput, EmployeeJobInputTypedDict, @@ -240,11 +240,9 @@ def serialize_model(self, handler): return m -class EmployeeTypedDict(TypedDict): +class EmployeeInputTypedDict(TypedDict): id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" - downstream_id: NotRequired[Nullable[str]] - r"""The third-party API ID of original entity""" first_name: NotRequired[Nullable[str]] r"""The first name of the person.""" last_name: NotRequired[Nullable[str]] @@ -263,7 +261,7 @@ class EmployeeTypedDict(TypedDict): r"""The job title of the person.""" marital_status: NotRequired[Nullable[str]] r"""The marital status of the employee.""" - partner: NotRequired[PersonTypedDict] + partner: NotRequired[PersonInputTypedDict] division: NotRequired[Nullable[str]] r"""The division the person is currently in. Usually a collection of departments or teams or regions.""" division_id: NotRequired[Nullable[str]] @@ -323,8 +321,8 @@ class EmployeeTypedDict(TypedDict): source_id: NotRequired[Nullable[str]] r"""Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).""" record_url: NotRequired[Nullable[str]] - jobs: NotRequired[Nullable[List[EmployeeJobTypedDict]]] - compensations: NotRequired[Nullable[List[EmployeeCompensationTypedDict]]] + jobs: NotRequired[Nullable[List[EmployeeJobInputTypedDict]]] + compensations: NotRequired[Nullable[List[EmployeeCompensationInputTypedDict]]] works_remote: NotRequired[Nullable[bool]] r"""Indicates if the employee works from a remote location.""" addresses: NotRequired[List[AddressTypedDict]] @@ -341,31 +339,18 @@ class EmployeeTypedDict(TypedDict): r"""Indicate the employee's food allergies.""" probation_period: NotRequired[ProbationPeriodTypedDict] tags: NotRequired[Nullable[List[str]]] - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" deleted: NotRequired[Nullable[bool]] r"""Flag to indicate if the object is deleted.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class Employee(BaseModel): +class EmployeeInput(BaseModel): id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" - downstream_id: OptionalNullable[str] = UNSET - r"""The third-party API ID of original entity""" - first_name: OptionalNullable[str] = UNSET r"""The first name of the person.""" @@ -393,7 +378,7 @@ class Employee(BaseModel): marital_status: OptionalNullable[str] = UNSET r"""The marital status of the employee.""" - partner: Optional[Person] = None + partner: Optional[PersonInput] = None division: OptionalNullable[str] = UNSET r"""The division the person is currently in. Usually a collection of departments or teams or regions.""" @@ -491,9 +476,9 @@ class Employee(BaseModel): record_url: OptionalNullable[str] = UNSET - jobs: OptionalNullable[List[EmployeeJob]] = UNSET + jobs: OptionalNullable[List[EmployeeJobInput]] = UNSET - compensations: OptionalNullable[List[EmployeeCompensation]] = UNSET + compensations: OptionalNullable[List[EmployeeCompensationInput]] = UNSET works_remote: OptionalNullable[bool] = UNSET r"""Indicates if the employee works from a remote location.""" @@ -524,27 +509,12 @@ class Employee(BaseModel): tags: OptionalNullable[List[str]] = UNSET - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" deleted: OptionalNullable[bool] = UNSET r"""Flag to indicate if the object is deleted.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -552,7 +522,6 @@ class Employee(BaseModel): def serialize_model(self, handler): optional_fields = [ "id", - "downstream_id", "first_name", "last_name", "middle_name", @@ -610,18 +579,12 @@ def serialize_model(self, handler): "food_allergies", "probation_period", "tags", - "custom_mappings", "row_version", "deleted", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", ] nullable_fields = [ "id", - "downstream_id", "first_name", "last_name", "middle_name", @@ -667,13 +630,8 @@ def serialize_model(self, handler): "dietary_preference", "food_allergies", "tags", - "custom_mappings", "row_version", "deleted", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -702,9 +660,11 @@ def serialize_model(self, handler): return m -class EmployeeInputTypedDict(TypedDict): +class EmployeeTypedDict(TypedDict): id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" + downstream_id: NotRequired[Nullable[str]] + r"""The third-party API ID of original entity""" first_name: NotRequired[Nullable[str]] r"""The first name of the person.""" last_name: NotRequired[Nullable[str]] @@ -723,7 +683,7 @@ class EmployeeInputTypedDict(TypedDict): r"""The job title of the person.""" marital_status: NotRequired[Nullable[str]] r"""The marital status of the employee.""" - partner: NotRequired[PersonInputTypedDict] + partner: NotRequired[PersonTypedDict] division: NotRequired[Nullable[str]] r"""The division the person is currently in. Usually a collection of departments or teams or regions.""" division_id: NotRequired[Nullable[str]] @@ -783,8 +743,8 @@ class EmployeeInputTypedDict(TypedDict): source_id: NotRequired[Nullable[str]] r"""Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).""" record_url: NotRequired[Nullable[str]] - jobs: NotRequired[Nullable[List[EmployeeJobInputTypedDict]]] - compensations: NotRequired[Nullable[List[EmployeeCompensationInputTypedDict]]] + jobs: NotRequired[Nullable[List[EmployeeJobTypedDict]]] + compensations: NotRequired[Nullable[List[EmployeeCompensationTypedDict]]] works_remote: NotRequired[Nullable[bool]] r"""Indicates if the employee works from a remote location.""" addresses: NotRequired[List[AddressTypedDict]] @@ -801,18 +761,31 @@ class EmployeeInputTypedDict(TypedDict): r"""Indicate the employee's food allergies.""" probation_period: NotRequired[ProbationPeriodTypedDict] tags: NotRequired[Nullable[List[str]]] + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" deleted: NotRequired[Nullable[bool]] r"""Flag to indicate if the object is deleted.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class EmployeeInput(BaseModel): +class Employee(BaseModel): id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" + downstream_id: OptionalNullable[str] = UNSET + r"""The third-party API ID of original entity""" + first_name: OptionalNullable[str] = UNSET r"""The first name of the person.""" @@ -840,7 +813,7 @@ class EmployeeInput(BaseModel): marital_status: OptionalNullable[str] = UNSET r"""The marital status of the employee.""" - partner: Optional[PersonInput] = None + partner: Optional[Person] = None division: OptionalNullable[str] = UNSET r"""The division the person is currently in. Usually a collection of departments or teams or regions.""" @@ -938,9 +911,9 @@ class EmployeeInput(BaseModel): record_url: OptionalNullable[str] = UNSET - jobs: OptionalNullable[List[EmployeeJobInput]] = UNSET + jobs: OptionalNullable[List[EmployeeJob]] = UNSET - compensations: OptionalNullable[List[EmployeeCompensationInput]] = UNSET + compensations: OptionalNullable[List[EmployeeCompensation]] = UNSET works_remote: OptionalNullable[bool] = UNSET r"""Indicates if the employee works from a remote location.""" @@ -971,12 +944,27 @@ class EmployeeInput(BaseModel): tags: OptionalNullable[List[str]] = UNSET + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" deleted: OptionalNullable[bool] = UNSET r"""Flag to indicate if the object is deleted.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -984,6 +972,7 @@ class EmployeeInput(BaseModel): def serialize_model(self, handler): optional_fields = [ "id", + "downstream_id", "first_name", "last_name", "middle_name", @@ -1041,12 +1030,18 @@ def serialize_model(self, handler): "food_allergies", "probation_period", "tags", + "custom_mappings", "row_version", "deleted", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", ] nullable_fields = [ "id", + "downstream_id", "first_name", "last_name", "middle_name", @@ -1092,8 +1087,13 @@ def serialize_model(self, handler): "dietary_preference", "food_allergies", "tags", + "custom_mappings", "row_version", "deleted", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/employeejob.py b/src/apideck_unify/models/employeejob_input.py similarity index 100% rename from src/apideck_unify/models/employeejob.py rename to src/apideck_unify/models/employeejob_input.py index 044ecbc3..82a83b26 100644 --- a/src/apideck_unify/models/employeejob.py +++ b/src/apideck_unify/models/employeejob_input.py @@ -26,11 +26,7 @@ class EmployeeJobStatus(str, Enum): OTHER = "other" -class EmployeeJobTypedDict(TypedDict): - id: NotRequired[Nullable[str]] - r"""A unique identifier for an object.""" - employee_id: NotRequired[Nullable[str]] - r"""A unique identifier for an object.""" +class EmployeeJobInputTypedDict(TypedDict): title: NotRequired[Nullable[str]] r"""The job title of the person.""" role: NotRequired[Nullable[str]] @@ -56,13 +52,7 @@ class EmployeeJobTypedDict(TypedDict): location: NotRequired[AddressTypedDict] -class EmployeeJob(BaseModel): - id: OptionalNullable[str] = UNSET - r"""A unique identifier for an object.""" - - employee_id: OptionalNullable[str] = UNSET - r"""A unique identifier for an object.""" - +class EmployeeJobInput(BaseModel): title: OptionalNullable[str] = UNSET r"""The job title of the person.""" @@ -101,8 +91,6 @@ class EmployeeJob(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", - "employee_id", "title", "role", "start_date", @@ -117,8 +105,6 @@ def serialize_model(self, handler): "location", ] nullable_fields = [ - "id", - "employee_id", "title", "role", "start_date", @@ -158,7 +144,11 @@ def serialize_model(self, handler): return m -class EmployeeJobInputTypedDict(TypedDict): +class EmployeeJobTypedDict(TypedDict): + id: NotRequired[Nullable[str]] + r"""A unique identifier for an object.""" + employee_id: NotRequired[Nullable[str]] + r"""A unique identifier for an object.""" title: NotRequired[Nullable[str]] r"""The job title of the person.""" role: NotRequired[Nullable[str]] @@ -184,7 +174,13 @@ class EmployeeJobInputTypedDict(TypedDict): location: NotRequired[AddressTypedDict] -class EmployeeJobInput(BaseModel): +class EmployeeJob(BaseModel): + id: OptionalNullable[str] = UNSET + r"""A unique identifier for an object.""" + + employee_id: OptionalNullable[str] = UNSET + r"""A unique identifier for an object.""" + title: OptionalNullable[str] = UNSET r"""The job title of the person.""" @@ -223,6 +219,8 @@ class EmployeeJobInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", + "employee_id", "title", "role", "start_date", @@ -237,6 +235,8 @@ def serialize_model(self, handler): "location", ] nullable_fields = [ + "id", + "employee_id", "title", "role", "start_date", diff --git a/src/apideck_unify/models/employeepayroll.py b/src/apideck_unify/models/employeepayroll.py index 2a5da9fb..e1e9e387 100644 --- a/src/apideck_unify/models/employeepayroll.py +++ b/src/apideck_unify/models/employeepayroll.py @@ -80,13 +80,13 @@ def serialize_model(self, handler): ] nullable_fields = [ "id", + "employee_id", + "company_id", "processed", + "processed_date", "check_date", "start_date", "end_date", - "employee_id", - "company_id", - "processed_date", ] null_default_fields = [] diff --git a/src/apideck_unify/models/employeeschedules.py b/src/apideck_unify/models/employeeschedules.py index 62a7b4d5..8a4649d7 100644 --- a/src/apideck_unify/models/employeeschedules.py +++ b/src/apideck_unify/models/employeeschedules.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .employee import Employee, EmployeeTypedDict +from .employee_input import Employee, EmployeeTypedDict from .schedule import Schedule, ScheduleTypedDict from apideck_unify.types import ( BaseModel, diff --git a/src/apideck_unify/models/expense.py b/src/apideck_unify/models/expense.py index 894f552a..540e16b3 100644 --- a/src/apideck_unify/models/expense.py +++ b/src/apideck_unify/models/expense.py @@ -172,8 +172,8 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ - "transaction_date", "number", + "transaction_date", "company_id", "department_id", "payment_type", @@ -324,8 +324,8 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ - "transaction_date", "number", + "transaction_date", "company_id", "department_id", "payment_type", diff --git a/src/apideck_unify/models/expenselineitem.py b/src/apideck_unify/models/expenselineitem.py index 56f9f937..97ae3b32 100644 --- a/src/apideck_unify/models/expenselineitem.py +++ b/src/apideck_unify/models/expenselineitem.py @@ -94,12 +94,12 @@ def serialize_model(self, handler): "billable", ] nullable_fields = [ - "total_amount", "tracking_categories", "department_id", "location_id", "subsidiary_id", "description", + "total_amount", ] null_default_fields = [] diff --git a/src/apideck_unify/models/expenselineitem_input.py b/src/apideck_unify/models/expenselineitem_input.py index f7f7e994..9f9f5a40 100644 --- a/src/apideck_unify/models/expenselineitem_input.py +++ b/src/apideck_unify/models/expenselineitem_input.py @@ -88,12 +88,12 @@ def serialize_model(self, handler): "billable", ] nullable_fields = [ - "total_amount", "tracking_categories", "department_id", "location_id", "subsidiary_id", "description", + "total_amount", ] null_default_fields = [] diff --git a/src/apideck_unify/models/getaccountingdepartmentresponse.py b/src/apideck_unify/models/getaccountingdepartmentresponse.py index a5ee206c..417fcab4 100644 --- a/src/apideck_unify/models/getaccountingdepartmentresponse.py +++ b/src/apideck_unify/models/getaccountingdepartmentresponse.py @@ -1,7 +1,10 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .accountingdepartment import AccountingDepartment, AccountingDepartmentTypedDict +from .accountingdepartment_input import ( + AccountingDepartment, + AccountingDepartmentTypedDict, +) from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getaccountingdepartmentsresponse.py b/src/apideck_unify/models/getaccountingdepartmentsresponse.py index a79c4be2..5a58405d 100644 --- a/src/apideck_unify/models/getaccountingdepartmentsresponse.py +++ b/src/apideck_unify/models/getaccountingdepartmentsresponse.py @@ -1,7 +1,10 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .accountingdepartment import AccountingDepartment, AccountingDepartmentTypedDict +from .accountingdepartment_input import ( + AccountingDepartment, + AccountingDepartmentTypedDict, +) from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getactivitiesresponse.py b/src/apideck_unify/models/getactivitiesresponse.py index a1f4da48..0c81fad3 100644 --- a/src/apideck_unify/models/getactivitiesresponse.py +++ b/src/apideck_unify/models/getactivitiesresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .activity import Activity, ActivityTypedDict +from .activity_input import Activity, ActivityTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getactivityresponse.py b/src/apideck_unify/models/getactivityresponse.py index 53f8b9e2..a5215dfa 100644 --- a/src/apideck_unify/models/getactivityresponse.py +++ b/src/apideck_unify/models/getactivityresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .activity import Activity, ActivityTypedDict +from .activity_input import Activity, ActivityTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getapplicantresponse.py b/src/apideck_unify/models/getapplicantresponse.py index 0111cc21..db5d1174 100644 --- a/src/apideck_unify/models/getapplicantresponse.py +++ b/src/apideck_unify/models/getapplicantresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .applicant import Applicant, ApplicantTypedDict +from .applicant_input import Applicant, ApplicantTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getapplicantsresponse.py b/src/apideck_unify/models/getapplicantsresponse.py index 72a27eef..5fce2573 100644 --- a/src/apideck_unify/models/getapplicantsresponse.py +++ b/src/apideck_unify/models/getapplicantsresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .applicant import Applicant, ApplicantTypedDict +from .applicant_input import Applicant, ApplicantTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getapplicationresponse.py b/src/apideck_unify/models/getapplicationresponse.py index 50bf5fdc..f362f33a 100644 --- a/src/apideck_unify/models/getapplicationresponse.py +++ b/src/apideck_unify/models/getapplicationresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .application import Application, ApplicationTypedDict +from .application_input import Application, ApplicationTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getapplicationsresponse.py b/src/apideck_unify/models/getapplicationsresponse.py index 75d2b5ab..833b203a 100644 --- a/src/apideck_unify/models/getapplicationsresponse.py +++ b/src/apideck_unify/models/getapplicationsresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .application import Application, ApplicationTypedDict +from .application_input import Application, ApplicationTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getbillresponse.py b/src/apideck_unify/models/getbillresponse.py index 881dde24..894052ca 100644 --- a/src/apideck_unify/models/getbillresponse.py +++ b/src/apideck_unify/models/getbillresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .bill import Bill, BillTypedDict +from .bill_input import Bill, BillTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getbillsresponse.py b/src/apideck_unify/models/getbillsresponse.py index 14d7508f..6683c93d 100644 --- a/src/apideck_unify/models/getbillsresponse.py +++ b/src/apideck_unify/models/getbillsresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .bill import Bill, BillTypedDict +from .bill_input import Bill, BillTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getconnectionresponse.py b/src/apideck_unify/models/getconnectionresponse.py index 1b960124..86c88939 100644 --- a/src/apideck_unify/models/getconnectionresponse.py +++ b/src/apideck_unify/models/getconnectionresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .connection import Connection, ConnectionTypedDict +from .connection_input import Connection, ConnectionTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getconnectionsresponse.py b/src/apideck_unify/models/getconnectionsresponse.py index 4e47e75a..e381c01d 100644 --- a/src/apideck_unify/models/getconnectionsresponse.py +++ b/src/apideck_unify/models/getconnectionsresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .connection import Connection, ConnectionTypedDict +from .connection_input import Connection, ConnectionTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getcontactresponse.py b/src/apideck_unify/models/getcontactresponse.py index 359c97bf..54e07159 100644 --- a/src/apideck_unify/models/getcontactresponse.py +++ b/src/apideck_unify/models/getcontactresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .contact import Contact, ContactTypedDict +from .contact_input import Contact, ContactTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getcontactsresponse.py b/src/apideck_unify/models/getcontactsresponse.py index 81a9bd5f..edbe6196 100644 --- a/src/apideck_unify/models/getcontactsresponse.py +++ b/src/apideck_unify/models/getcontactsresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .contact import Contact, ContactTypedDict +from .contact_input import Contact, ContactTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getcreditnoteresponse.py b/src/apideck_unify/models/getcreditnoteresponse.py index 21a84b5b..fa1be55f 100644 --- a/src/apideck_unify/models/getcreditnoteresponse.py +++ b/src/apideck_unify/models/getcreditnoteresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .creditnote import CreditNote, CreditNoteTypedDict +from .creditnote_input import CreditNote, CreditNoteTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getcreditnotesresponse.py b/src/apideck_unify/models/getcreditnotesresponse.py index a9e656b3..cc3495a8 100644 --- a/src/apideck_unify/models/getcreditnotesresponse.py +++ b/src/apideck_unify/models/getcreditnotesresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .creditnote import CreditNote, CreditNoteTypedDict +from .creditnote_input import CreditNote, CreditNoteTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getemployeeresponse.py b/src/apideck_unify/models/getemployeeresponse.py index ef5ea2b3..02691620 100644 --- a/src/apideck_unify/models/getemployeeresponse.py +++ b/src/apideck_unify/models/getemployeeresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .employee import Employee, EmployeeTypedDict +from .employee_input import Employee, EmployeeTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getemployeesresponse.py b/src/apideck_unify/models/getemployeesresponse.py index 0b215ad2..8f6f2a63 100644 --- a/src/apideck_unify/models/getemployeesresponse.py +++ b/src/apideck_unify/models/getemployeesresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .employee import Employee, EmployeeTypedDict +from .employee_input import Employee, EmployeeTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getledgeraccountresponse.py b/src/apideck_unify/models/getledgeraccountresponse.py index b7f68a00..ab75e369 100644 --- a/src/apideck_unify/models/getledgeraccountresponse.py +++ b/src/apideck_unify/models/getledgeraccountresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .ledgeraccount import LedgerAccount, LedgerAccountTypedDict +from .ledgeraccount_input import LedgerAccount, LedgerAccountTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getledgeraccountsresponse.py b/src/apideck_unify/models/getledgeraccountsresponse.py index 922cea0f..96bcbff5 100644 --- a/src/apideck_unify/models/getledgeraccountsresponse.py +++ b/src/apideck_unify/models/getledgeraccountsresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .ledgeraccount import LedgerAccount, LedgerAccountTypedDict +from .ledgeraccount_input import LedgerAccount, LedgerAccountTypedDict from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( diff --git a/src/apideck_unify/models/getmessageresponse.py b/src/apideck_unify/models/getmessageresponse.py index 7d4cb34b..30cdfee0 100644 --- a/src/apideck_unify/models/getmessageresponse.py +++ b/src/apideck_unify/models/getmessageresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .message import Message, MessageTypedDict +from .message_input import Message, MessageTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getmessagesresponse.py b/src/apideck_unify/models/getmessagesresponse.py index ff2ba63f..96dc634a 100644 --- a/src/apideck_unify/models/getmessagesresponse.py +++ b/src/apideck_unify/models/getmessagesresponse.py @@ -2,7 +2,7 @@ from __future__ import annotations from .links import Links, LinksTypedDict -from .message import Message, MessageTypedDict +from .message_input import Message, MessageTypedDict from .meta import Meta, MetaTypedDict from apideck_unify.types import ( BaseModel, diff --git a/src/apideck_unify/models/getpurchaseorderresponse.py b/src/apideck_unify/models/getpurchaseorderresponse.py index 2a202108..93a2f14d 100644 --- a/src/apideck_unify/models/getpurchaseorderresponse.py +++ b/src/apideck_unify/models/getpurchaseorderresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .purchaseorder import PurchaseOrder, PurchaseOrderTypedDict +from .purchaseorder_input import PurchaseOrder, PurchaseOrderTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getpurchaseordersresponse.py b/src/apideck_unify/models/getpurchaseordersresponse.py index d8db01bb..64f34749 100644 --- a/src/apideck_unify/models/getpurchaseordersresponse.py +++ b/src/apideck_unify/models/getpurchaseordersresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict -from .purchaseorder import PurchaseOrder, PurchaseOrderTypedDict +from .purchaseorder_input import PurchaseOrder, PurchaseOrderTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getsubsidiariesresponse.py b/src/apideck_unify/models/getsubsidiariesresponse.py index 472c6c9e..56173846 100644 --- a/src/apideck_unify/models/getsubsidiariesresponse.py +++ b/src/apideck_unify/models/getsubsidiariesresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict -from .subsidiary import Subsidiary, SubsidiaryTypedDict +from .subsidiary_input import Subsidiary, SubsidiaryTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getsubsidiaryresponse.py b/src/apideck_unify/models/getsubsidiaryresponse.py index 90785645..7eacfd43 100644 --- a/src/apideck_unify/models/getsubsidiaryresponse.py +++ b/src/apideck_unify/models/getsubsidiaryresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .subsidiary import Subsidiary, SubsidiaryTypedDict +from .subsidiary_input import Subsidiary, SubsidiaryTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/gettaxrateresponse.py b/src/apideck_unify/models/gettaxrateresponse.py index e5f57122..0095d52e 100644 --- a/src/apideck_unify/models/gettaxrateresponse.py +++ b/src/apideck_unify/models/gettaxrateresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .taxrate import TaxRate, TaxRateTypedDict +from .taxrate_input import TaxRate, TaxRateTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/gettaxratesresponse.py b/src/apideck_unify/models/gettaxratesresponse.py index 9e3b9bea..e021ae47 100644 --- a/src/apideck_unify/models/gettaxratesresponse.py +++ b/src/apideck_unify/models/gettaxratesresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict -from .taxrate import TaxRate, TaxRateTypedDict +from .taxrate_input import TaxRate, TaxRateTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getticketresponse.py b/src/apideck_unify/models/getticketresponse.py index f22694eb..50275a66 100644 --- a/src/apideck_unify/models/getticketresponse.py +++ b/src/apideck_unify/models/getticketresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .ticket import Ticket, TicketTypedDict +from .ticket_input import Ticket, TicketTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/getticketsresponse.py b/src/apideck_unify/models/getticketsresponse.py index ae6d5cde..1b25b115 100644 --- a/src/apideck_unify/models/getticketsresponse.py +++ b/src/apideck_unify/models/getticketsresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict -from .ticket import Ticket, TicketTypedDict +from .ticket_input import Ticket, TicketTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/gettimeoffrequestresponse.py b/src/apideck_unify/models/gettimeoffrequestresponse.py index 7436f31c..f44d0781 100644 --- a/src/apideck_unify/models/gettimeoffrequestresponse.py +++ b/src/apideck_unify/models/gettimeoffrequestresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .timeoffrequest import TimeOffRequest, TimeOffRequestTypedDict +from .timeoffrequest_input import TimeOffRequest, TimeOffRequestTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/gettimeoffrequestsresponse.py b/src/apideck_unify/models/gettimeoffrequestsresponse.py index bfd32e9e..38dc688c 100644 --- a/src/apideck_unify/models/gettimeoffrequestsresponse.py +++ b/src/apideck_unify/models/gettimeoffrequestsresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict -from .timeoffrequest import TimeOffRequest, TimeOffRequestTypedDict +from .timeoffrequest_input import TimeOffRequest, TimeOffRequestTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/gettrackingcategoriesresponse.py b/src/apideck_unify/models/gettrackingcategoriesresponse.py index 97c16da5..4a25388d 100644 --- a/src/apideck_unify/models/gettrackingcategoriesresponse.py +++ b/src/apideck_unify/models/gettrackingcategoriesresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations from .links import Links, LinksTypedDict from .meta import Meta, MetaTypedDict -from .trackingcategory import TrackingCategory, TrackingCategoryTypedDict +from .trackingcategory_input import TrackingCategory, TrackingCategoryTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/gettrackingcategoryresponse.py b/src/apideck_unify/models/gettrackingcategoryresponse.py index 720f9d60..15eb74fe 100644 --- a/src/apideck_unify/models/gettrackingcategoryresponse.py +++ b/src/apideck_unify/models/gettrackingcategoryresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .trackingcategory import TrackingCategory, TrackingCategoryTypedDict +from .trackingcategory_input import TrackingCategory, TrackingCategoryTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/hris_employeesaddop.py b/src/apideck_unify/models/hris_employeesaddop.py index 004e4a32..5c3a39f5 100644 --- a/src/apideck_unify/models/hris_employeesaddop.py +++ b/src/apideck_unify/models/hris_employeesaddop.py @@ -5,7 +5,7 @@ CreateEmployeeResponse, CreateEmployeeResponseTypedDict, ) -from .employee import EmployeeInput, EmployeeInputTypedDict +from .employee_input import EmployeeInput, EmployeeInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/hris_employeesupdateop.py b/src/apideck_unify/models/hris_employeesupdateop.py index 8e3bfca7..d2257b55 100644 --- a/src/apideck_unify/models/hris_employeesupdateop.py +++ b/src/apideck_unify/models/hris_employeesupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .employee import EmployeeInput, EmployeeInputTypedDict +from .employee_input import EmployeeInput, EmployeeInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/hris_timeoffrequestsaddop.py b/src/apideck_unify/models/hris_timeoffrequestsaddop.py index 34b1e14d..f0ee3f6a 100644 --- a/src/apideck_unify/models/hris_timeoffrequestsaddop.py +++ b/src/apideck_unify/models/hris_timeoffrequestsaddop.py @@ -6,7 +6,7 @@ CreateTimeOffRequestResponseTypedDict, ) from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .timeoffrequest import TimeOffRequestInput, TimeOffRequestInputTypedDict +from .timeoffrequest_input import TimeOffRequestInput, TimeOffRequestInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/hris_timeoffrequestsupdateop.py b/src/apideck_unify/models/hris_timeoffrequestsupdateop.py index 4351afa0..d5eb95b3 100644 --- a/src/apideck_unify/models/hris_timeoffrequestsupdateop.py +++ b/src/apideck_unify/models/hris_timeoffrequestsupdateop.py @@ -2,7 +2,7 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .timeoffrequest import TimeOffRequestInput, TimeOffRequestInputTypedDict +from .timeoffrequest_input import TimeOffRequestInput, TimeOffRequestInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/issuetracking_collectionticketsaddop.py b/src/apideck_unify/models/issuetracking_collectionticketsaddop.py index e29d391a..8bd8da86 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketsaddop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketsaddop.py @@ -3,7 +3,7 @@ from __future__ import annotations from .createticketresponse import CreateTicketResponse, CreateTicketResponseTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .ticket import TicketInput, TicketInputTypedDict +from .ticket_input import TicketInput, TicketInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py b/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py index 46304830..dab3f9a9 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py @@ -2,7 +2,7 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .ticket import TicketInput, TicketInputTypedDict +from .ticket_input import TicketInput, TicketInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/journalentrylineitem.py b/src/apideck_unify/models/journalentrylineitem.py index db1ddc04..249112c2 100644 --- a/src/apideck_unify/models/journalentrylineitem.py +++ b/src/apideck_unify/models/journalentrylineitem.py @@ -141,13 +141,13 @@ def serialize_model(self, handler): "line_number", ] nullable_fields = [ - "ledger_account", "description", "tax_amount", "sub_total", "total_amount", "tracking_category", "tracking_categories", + "ledger_account", "customer", "supplier", "department_id", @@ -275,13 +275,13 @@ def serialize_model(self, handler): "line_number", ] nullable_fields = [ - "ledger_account", "description", "tax_amount", "sub_total", "total_amount", "tracking_category", "tracking_categories", + "ledger_account", "customer", "supplier", "department_id", diff --git a/src/apideck_unify/models/ledgeraccount.py b/src/apideck_unify/models/ledgeraccount_input.py similarity index 100% rename from src/apideck_unify/models/ledgeraccount.py rename to src/apideck_unify/models/ledgeraccount_input.py index 84561aa2..370acb03 100644 --- a/src/apideck_unify/models/ledgeraccount.py +++ b/src/apideck_unify/models/ledgeraccount_input.py @@ -71,19 +71,6 @@ class AccountStatus(str, Enum): ARCHIVED = "archived" -class CategoriesTypedDict(TypedDict): - id: NotRequired[str] - name: NotRequired[str] - r"""The name of the category.""" - - -class Categories(BaseModel): - id: Optional[str] = None - - name: Optional[str] = None - r"""The name of the category.""" - - class ParentAccountTypedDict(TypedDict): id: NotRequired[str] r"""The ID of the parent account.""" @@ -104,21 +91,6 @@ class ParentAccount(BaseModel): r"""The human readable display ID used when displaying the parent account""" -class SubAccountsTypedDict(TypedDict): - id: NotRequired[str] - r"""The ID of the sub account.""" - account_sub_name: NotRequired[str] - r"""The name of the sub account.""" - - -class SubAccounts(BaseModel): - id: Optional[str] = None - r"""The ID of the sub account.""" - - account_sub_name: Optional[str] = None - r"""The name of the sub account.""" - - class LedgerAccountSubsidiariesTypedDict(TypedDict): id: NotRequired[str] r"""The ID of the subsidiary.""" @@ -129,9 +101,7 @@ class LedgerAccountSubsidiaries(BaseModel): r"""The ID of the subsidiary.""" -class LedgerAccountTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" +class LedgerAccountInputTypedDict(TypedDict): display_id: NotRequired[str] r"""The human readable display ID used when displaying the account""" nominal_code: NotRequired[Nullable[str]] @@ -158,7 +128,7 @@ class LedgerAccountTypedDict(TypedDict): r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" tax_type: NotRequired[Nullable[str]] r"""The tax type of the account.""" - tax_rate: NotRequired[LinkedTaxRateTypedDict] + tax_rate: NotRequired[LinkedTaxRateInputTypedDict] level: NotRequired[Nullable[float]] active: NotRequired[Nullable[bool]] r"""Whether the account is active or not.""" @@ -167,38 +137,21 @@ class LedgerAccountTypedDict(TypedDict): header: NotRequired[Nullable[bool]] r"""Whether the account is a header or not.""" bank_account: NotRequired[BankAccountTypedDict] - categories: NotRequired[List[CategoriesTypedDict]] - r"""The categories of the account.""" parent_account: NotRequired[ParentAccountTypedDict] sub_account: NotRequired[Nullable[bool]] r"""Whether the account is a sub account or not.""" - sub_accounts: NotRequired[List[SubAccountsTypedDict]] - r"""The sub accounts of the account.""" last_reconciliation_date: NotRequired[Nullable[date]] r"""Reconciliation Date means the last calendar day of each Reconciliation Period.""" subsidiaries: NotRequired[List[LedgerAccountSubsidiariesTypedDict]] r"""The subsidiaries the account belongs to.""" - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class LedgerAccount(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - +class LedgerAccountInput(BaseModel): display_id: Optional[str] = None r"""The human readable display ID used when displaying the account""" @@ -243,7 +196,7 @@ class LedgerAccount(BaseModel): tax_type: OptionalNullable[str] = UNSET r"""The tax type of the account.""" - tax_rate: Optional[LinkedTaxRate] = None + tax_rate: Optional[LinkedTaxRateInput] = None level: OptionalNullable[float] = UNSET @@ -258,50 +211,28 @@ class LedgerAccount(BaseModel): bank_account: Optional[BankAccount] = None - categories: Optional[List[Categories]] = None - r"""The categories of the account.""" - parent_account: Optional[ParentAccount] = None sub_account: OptionalNullable[bool] = UNSET r"""Whether the account is a sub account or not.""" - sub_accounts: Optional[List[SubAccounts]] = None - r"""The sub accounts of the account.""" - last_reconciliation_date: OptionalNullable[date] = UNSET r"""Reconciliation Date means the last calendar day of each Reconciliation Period.""" subsidiaries: Optional[List[LedgerAccountSubsidiaries]] = None r"""The subsidiaries the account belongs to.""" - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - custom_fields: Optional[List[CustomField]] = None row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", "display_id", "nominal_code", "code", @@ -321,19 +252,12 @@ def serialize_model(self, handler): "status", "header", "bank_account", - "categories", "parent_account", "sub_account", - "sub_accounts", "last_reconciliation_date", "subsidiaries", - "custom_mappings", "custom_fields", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", ] nullable_fields = [ @@ -354,12 +278,7 @@ def serialize_model(self, handler): "header", "sub_account", "last_reconciliation_date", - "custom_mappings", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -388,7 +307,37 @@ def serialize_model(self, handler): return m -class LedgerAccountInputTypedDict(TypedDict): +class CategoriesTypedDict(TypedDict): + id: NotRequired[str] + name: NotRequired[str] + r"""The name of the category.""" + + +class Categories(BaseModel): + id: Optional[str] = None + + name: Optional[str] = None + r"""The name of the category.""" + + +class SubAccountsTypedDict(TypedDict): + id: NotRequired[str] + r"""The ID of the sub account.""" + account_sub_name: NotRequired[str] + r"""The name of the sub account.""" + + +class SubAccounts(BaseModel): + id: Optional[str] = None + r"""The ID of the sub account.""" + + account_sub_name: Optional[str] = None + r"""The name of the sub account.""" + + +class LedgerAccountTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" display_id: NotRequired[str] r"""The human readable display ID used when displaying the account""" nominal_code: NotRequired[Nullable[str]] @@ -415,7 +364,7 @@ class LedgerAccountInputTypedDict(TypedDict): r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" tax_type: NotRequired[Nullable[str]] r"""The tax type of the account.""" - tax_rate: NotRequired[LinkedTaxRateInputTypedDict] + tax_rate: NotRequired[LinkedTaxRateTypedDict] level: NotRequired[Nullable[float]] active: NotRequired[Nullable[bool]] r"""Whether the account is active or not.""" @@ -424,21 +373,38 @@ class LedgerAccountInputTypedDict(TypedDict): header: NotRequired[Nullable[bool]] r"""Whether the account is a header or not.""" bank_account: NotRequired[BankAccountTypedDict] + categories: NotRequired[List[CategoriesTypedDict]] + r"""The categories of the account.""" parent_account: NotRequired[ParentAccountTypedDict] sub_account: NotRequired[Nullable[bool]] r"""Whether the account is a sub account or not.""" + sub_accounts: NotRequired[List[SubAccountsTypedDict]] + r"""The sub accounts of the account.""" last_reconciliation_date: NotRequired[Nullable[date]] r"""Reconciliation Date means the last calendar day of each Reconciliation Period.""" subsidiaries: NotRequired[List[LedgerAccountSubsidiariesTypedDict]] r"""The subsidiaries the account belongs to.""" + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class LedgerAccountInput(BaseModel): +class LedgerAccount(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + display_id: Optional[str] = None r"""The human readable display ID used when displaying the account""" @@ -483,7 +449,7 @@ class LedgerAccountInput(BaseModel): tax_type: OptionalNullable[str] = UNSET r"""The tax type of the account.""" - tax_rate: Optional[LinkedTaxRateInput] = None + tax_rate: Optional[LinkedTaxRate] = None level: OptionalNullable[float] = UNSET @@ -498,28 +464,50 @@ class LedgerAccountInput(BaseModel): bank_account: Optional[BankAccount] = None + categories: Optional[List[Categories]] = None + r"""The categories of the account.""" + parent_account: Optional[ParentAccount] = None sub_account: OptionalNullable[bool] = UNSET r"""Whether the account is a sub account or not.""" + sub_accounts: Optional[List[SubAccounts]] = None + r"""The sub accounts of the account.""" + last_reconciliation_date: OptionalNullable[date] = UNSET r"""Reconciliation Date means the last calendar day of each Reconciliation Period.""" subsidiaries: Optional[List[LedgerAccountSubsidiaries]] = None r"""The subsidiaries the account belongs to.""" + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + custom_fields: Optional[List[CustomField]] = None row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", "display_id", "nominal_code", "code", @@ -539,12 +527,19 @@ def serialize_model(self, handler): "status", "header", "bank_account", + "categories", "parent_account", "sub_account", + "sub_accounts", "last_reconciliation_date", "subsidiaries", + "custom_mappings", "custom_fields", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", ] nullable_fields = [ @@ -565,7 +560,12 @@ def serialize_model(self, handler): "header", "sub_account", "last_reconciliation_date", + "custom_mappings", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/log.py b/src/apideck_unify/models/log.py index 92ae91b9..2de7f752 100644 --- a/src/apideck_unify/models/log.py +++ b/src/apideck_unify/models/log.py @@ -180,7 +180,7 @@ class Log(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["error_message", "source_ip"] - nullable_fields = ["parent_id", "error_message", "source_ip"] + nullable_fields = ["error_message", "parent_id", "source_ip"] null_default_fields = [] serialized = handler(self) diff --git a/src/apideck_unify/models/message.py b/src/apideck_unify/models/message_input.py similarity index 100% rename from src/apideck_unify/models/message.py rename to src/apideck_unify/models/message_input.py index df8dcfda..c99c024d 100644 --- a/src/apideck_unify/models/message.py +++ b/src/apideck_unify/models/message_input.py @@ -26,6 +26,59 @@ class MessageType(str, Enum): MMS = "mms" +class MessageInputTypedDict(TypedDict): + from_: str + r"""The phone number that initiated the message.""" + to: str + r"""The phone number that received the message.""" + body: str + r"""The message text.""" + subject: NotRequired[str] + type: NotRequired[MessageType] + r"""Set to sms for SMS messages and mms for MMS messages.""" + scheduled_at: NotRequired[datetime] + r"""The scheduled date and time of the message.""" + webhook_url: NotRequired[str] + r"""Define a webhook to receive delivery notifications.""" + reference: NotRequired[str] + r"""A client reference.""" + messaging_service_id: NotRequired[str] + r"""The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.""" + pass_through: NotRequired[List[PassThroughBodyTypedDict]] + r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" + + +class MessageInput(BaseModel): + from_: Annotated[str, pydantic.Field(alias="from")] + r"""The phone number that initiated the message.""" + + to: str + r"""The phone number that received the message.""" + + body: str + r"""The message text.""" + + subject: Optional[str] = None + + type: Optional[MessageType] = None + r"""Set to sms for SMS messages and mms for MMS messages.""" + + scheduled_at: Optional[datetime] = None + r"""The scheduled date and time of the message.""" + + webhook_url: Optional[str] = None + r"""Define a webhook to receive delivery notifications.""" + + reference: Optional[str] = None + r"""A client reference.""" + + messaging_service_id: Optional[str] = None + r"""The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.""" + + pass_through: Optional[List[PassThroughBody]] = None + r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" + + class Direction(str, Enum): r"""The direction of the message.""" @@ -293,56 +346,3 @@ def serialize_model(self, handler): m[k] = val return m - - -class MessageInputTypedDict(TypedDict): - from_: str - r"""The phone number that initiated the message.""" - to: str - r"""The phone number that received the message.""" - body: str - r"""The message text.""" - subject: NotRequired[str] - type: NotRequired[MessageType] - r"""Set to sms for SMS messages and mms for MMS messages.""" - scheduled_at: NotRequired[datetime] - r"""The scheduled date and time of the message.""" - webhook_url: NotRequired[str] - r"""Define a webhook to receive delivery notifications.""" - reference: NotRequired[str] - r"""A client reference.""" - messaging_service_id: NotRequired[str] - r"""The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.""" - pass_through: NotRequired[List[PassThroughBodyTypedDict]] - r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" - - -class MessageInput(BaseModel): - from_: Annotated[str, pydantic.Field(alias="from")] - r"""The phone number that initiated the message.""" - - to: str - r"""The phone number that received the message.""" - - body: str - r"""The message text.""" - - subject: Optional[str] = None - - type: Optional[MessageType] = None - r"""Set to sms for SMS messages and mms for MMS messages.""" - - scheduled_at: Optional[datetime] = None - r"""The scheduled date and time of the message.""" - - webhook_url: Optional[str] = None - r"""Define a webhook to receive delivery notifications.""" - - reference: Optional[str] = None - r"""A client reference.""" - - messaging_service_id: Optional[str] = None - r"""The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.""" - - pass_through: Optional[List[PassThroughBody]] = None - r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" diff --git a/src/apideck_unify/models/payment.py b/src/apideck_unify/models/payment.py index e266459c..0c15a517 100644 --- a/src/apideck_unify/models/payment.py +++ b/src/apideck_unify/models/payment.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .allocation import Allocation, AllocationTypedDict +from .allocation_input import Allocation, AllocationTypedDict from .currency import Currency from .customfield import CustomField, CustomFieldTypedDict from .custommappings import CustomMappings, CustomMappingsTypedDict @@ -243,11 +243,10 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ - "total_amount", - "transaction_date", "downstream_id", "currency", "currency_rate", + "total_amount", "reference", "payment_method", "payment_method_reference", @@ -255,6 +254,7 @@ def serialize_model(self, handler): "accounts_receivable_account_type", "accounts_receivable_account_id", "account", + "transaction_date", "customer", "supplier", "company_id", diff --git a/src/apideck_unify/models/payment_input.py b/src/apideck_unify/models/payment_input.py index 0ee8e47d..e9b3c8d6 100644 --- a/src/apideck_unify/models/payment_input.py +++ b/src/apideck_unify/models/payment_input.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .allocation import AllocationInput, AllocationInputTypedDict +from .allocation_input import AllocationInput, AllocationInputTypedDict from .currency import Currency from .customfield import CustomField, CustomFieldTypedDict from .deprecatedlinkedsupplier_input import ( @@ -204,10 +204,9 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ - "total_amount", - "transaction_date", "currency", "currency_rate", + "total_amount", "reference", "payment_method", "payment_method_reference", @@ -215,6 +214,7 @@ def serialize_model(self, handler): "accounts_receivable_account_type", "accounts_receivable_account_id", "account", + "transaction_date", "customer", "supplier", "company_id", diff --git a/src/apideck_unify/models/payroll.py b/src/apideck_unify/models/payroll.py index 2514dd9e..3cba4f28 100644 --- a/src/apideck_unify/models/payroll.py +++ b/src/apideck_unify/models/payroll.py @@ -81,12 +81,12 @@ def serialize_model(self, handler): ] nullable_fields = [ "id", + "company_id", "processed", + "processed_date", "check_date", "start_date", "end_date", - "company_id", - "processed_date", "custom_mappings", ] null_default_fields = [] diff --git a/src/apideck_unify/models/profitandloss.py b/src/apideck_unify/models/profitandloss.py index 61642a66..e296e245 100644 --- a/src/apideck_unify/models/profitandloss.py +++ b/src/apideck_unify/models/profitandloss.py @@ -59,7 +59,7 @@ class Income(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["id", "code", "title", "type"] - nullable_fields = ["total", "type"] + nullable_fields = ["type", "total"] null_default_fields = [] serialized = handler(self) @@ -126,7 +126,7 @@ class CostOfGoodsSold(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["id", "code", "title", "type"] - nullable_fields = ["total", "type"] + nullable_fields = ["type", "total"] null_default_fields = [] serialized = handler(self) @@ -193,7 +193,7 @@ class ExpensesModel(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["id", "code", "title", "type"] - nullable_fields = ["total", "type"] + nullable_fields = ["type", "total"] null_default_fields = [] serialized = handler(self) @@ -260,7 +260,7 @@ class OtherIncome(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["id", "code", "title", "type"] - nullable_fields = ["total", "type"] + nullable_fields = ["type", "total"] null_default_fields = [] serialized = handler(self) @@ -327,7 +327,7 @@ class OtherExpenses(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["id", "code", "title", "type"] - nullable_fields = ["total", "type"] + nullable_fields = ["type", "total"] null_default_fields = [] serialized = handler(self) @@ -394,7 +394,7 @@ class UncategorizedAccounts(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["id", "code", "title", "type"] - nullable_fields = ["total", "type"] + nullable_fields = ["type", "total"] null_default_fields = [] serialized = handler(self) diff --git a/src/apideck_unify/models/purchaseorder.py b/src/apideck_unify/models/purchaseorder_input.py similarity index 100% rename from src/apideck_unify/models/purchaseorder.py rename to src/apideck_unify/models/purchaseorder_input.py index 0184b3a6..dbb1cf63 100644 --- a/src/apideck_unify/models/purchaseorder.py +++ b/src/apideck_unify/models/purchaseorder_input.py @@ -47,16 +47,12 @@ class PurchaseOrderStatus(str, Enum): OTHER = "other" -class PurchaseOrderTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" - downstream_id: NotRequired[Nullable[str]] - r"""The third-party API ID of original entity""" +class PurchaseOrderInputTypedDict(TypedDict): po_number: NotRequired[Nullable[str]] r"""A PO Number uniquely identifies a purchase order and is generally defined by the buyer.""" reference: NotRequired[Nullable[str]] r"""Optional purchase order reference.""" - supplier: NotRequired[Nullable[LinkedSupplierTypedDict]] + supplier: NotRequired[Nullable[LinkedSupplierInputTypedDict]] r"""The supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] r"""The company or subsidiary id the transaction belongs to""" @@ -79,9 +75,9 @@ class PurchaseOrderTypedDict(TypedDict): r"""Total amount of invoice, including tax.""" tax_inclusive: NotRequired[Nullable[bool]] r"""Amounts are including tax""" - line_items: NotRequired[List[InvoiceLineItemTypedDict]] + line_items: NotRequired[List[InvoiceLineItemInputTypedDict]] shipping_address: NotRequired[AddressTypedDict] - ledger_account: NotRequired[Nullable[LinkedLedgerAccountTypedDict]] + ledger_account: NotRequired[Nullable[LinkedLedgerAccountInputTypedDict]] template_id: NotRequired[Nullable[str]] r"""Optional purchase order template""" discount_percentage: NotRequired[Nullable[float]] @@ -103,37 +99,21 @@ class PurchaseOrderTypedDict(TypedDict): Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] ] r"""A list of linked tracking categories.""" - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class PurchaseOrder(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - - downstream_id: OptionalNullable[str] = UNSET - r"""The third-party API ID of original entity""" - +class PurchaseOrderInput(BaseModel): po_number: OptionalNullable[str] = UNSET r"""A PO Number uniquely identifies a purchase order and is generally defined by the buyer.""" reference: OptionalNullable[str] = UNSET r"""Optional purchase order reference.""" - supplier: OptionalNullable[LinkedSupplier] = UNSET + supplier: OptionalNullable[LinkedSupplierInput] = UNSET r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET @@ -168,11 +148,11 @@ class PurchaseOrder(BaseModel): tax_inclusive: OptionalNullable[bool] = UNSET r"""Amounts are including tax""" - line_items: Optional[List[InvoiceLineItem]] = None + line_items: Optional[List[InvoiceLineItemInput]] = None shipping_address: Optional[Address] = None - ledger_account: OptionalNullable[LinkedLedgerAccount] = UNSET + ledger_account: OptionalNullable[LinkedLedgerAccountInput] = UNSET template_id: OptionalNullable[str] = UNSET r"""Optional purchase order template""" @@ -205,34 +185,17 @@ class PurchaseOrder(BaseModel): ) r"""A list of linked tracking categories.""" - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - custom_fields: Optional[List[CustomField]] = None row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", - "downstream_id", "po_number", "reference", "supplier", @@ -260,17 +223,11 @@ def serialize_model(self, handler): "channel", "memo", "tracking_categories", - "custom_mappings", "custom_fields", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", ] nullable_fields = [ - "downstream_id", "po_number", "reference", "supplier", @@ -295,12 +252,7 @@ def serialize_model(self, handler): "channel", "memo", "tracking_categories", - "custom_mappings", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -329,12 +281,16 @@ def serialize_model(self, handler): return m -class PurchaseOrderInputTypedDict(TypedDict): +class PurchaseOrderTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" + downstream_id: NotRequired[Nullable[str]] + r"""The third-party API ID of original entity""" po_number: NotRequired[Nullable[str]] r"""A PO Number uniquely identifies a purchase order and is generally defined by the buyer.""" reference: NotRequired[Nullable[str]] r"""Optional purchase order reference.""" - supplier: NotRequired[Nullable[LinkedSupplierInputTypedDict]] + supplier: NotRequired[Nullable[LinkedSupplierTypedDict]] r"""The supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] r"""The company or subsidiary id the transaction belongs to""" @@ -357,9 +313,9 @@ class PurchaseOrderInputTypedDict(TypedDict): r"""Total amount of invoice, including tax.""" tax_inclusive: NotRequired[Nullable[bool]] r"""Amounts are including tax""" - line_items: NotRequired[List[InvoiceLineItemInputTypedDict]] + line_items: NotRequired[List[InvoiceLineItemTypedDict]] shipping_address: NotRequired[AddressTypedDict] - ledger_account: NotRequired[Nullable[LinkedLedgerAccountInputTypedDict]] + ledger_account: NotRequired[Nullable[LinkedLedgerAccountTypedDict]] template_id: NotRequired[Nullable[str]] r"""Optional purchase order template""" discount_percentage: NotRequired[Nullable[float]] @@ -381,21 +337,37 @@ class PurchaseOrderInputTypedDict(TypedDict): Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] ] r"""A list of linked tracking categories.""" + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" custom_fields: NotRequired[List[CustomFieldTypedDict]] row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class PurchaseOrderInput(BaseModel): +class PurchaseOrder(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + + downstream_id: OptionalNullable[str] = UNSET + r"""The third-party API ID of original entity""" + po_number: OptionalNullable[str] = UNSET r"""A PO Number uniquely identifies a purchase order and is generally defined by the buyer.""" reference: OptionalNullable[str] = UNSET r"""Optional purchase order reference.""" - supplier: OptionalNullable[LinkedSupplierInput] = UNSET + supplier: OptionalNullable[LinkedSupplier] = UNSET r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET @@ -430,11 +402,11 @@ class PurchaseOrderInput(BaseModel): tax_inclusive: OptionalNullable[bool] = UNSET r"""Amounts are including tax""" - line_items: Optional[List[InvoiceLineItemInput]] = None + line_items: Optional[List[InvoiceLineItem]] = None shipping_address: Optional[Address] = None - ledger_account: OptionalNullable[LinkedLedgerAccountInput] = UNSET + ledger_account: OptionalNullable[LinkedLedgerAccount] = UNSET template_id: OptionalNullable[str] = UNSET r"""Optional purchase order template""" @@ -467,17 +439,34 @@ class PurchaseOrderInput(BaseModel): ) r"""A list of linked tracking categories.""" + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + custom_fields: Optional[List[CustomField]] = None row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", + "downstream_id", "po_number", "reference", "supplier", @@ -505,11 +494,17 @@ def serialize_model(self, handler): "channel", "memo", "tracking_categories", + "custom_mappings", "custom_fields", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", ] nullable_fields = [ + "downstream_id", "po_number", "reference", "supplier", @@ -534,7 +529,12 @@ def serialize_model(self, handler): "channel", "memo", "tracking_categories", + "custom_mappings", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/sharedlink.py b/src/apideck_unify/models/sharedlink.py index c70cac9b..a664976e 100644 --- a/src/apideck_unify/models/sharedlink.py +++ b/src/apideck_unify/models/sharedlink.py @@ -150,7 +150,7 @@ class SharedLinkInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = ["download_url", "scope", "password", "pass_through"] - nullable_fields = ["target_id", "download_url", "scope", "password"] + nullable_fields = ["download_url", "target_id", "scope", "password"] null_default_fields = [] serialized = handler(self) diff --git a/src/apideck_unify/models/sms_messagesaddop.py b/src/apideck_unify/models/sms_messagesaddop.py index 7c3dc499..e91bd728 100644 --- a/src/apideck_unify/models/sms_messagesaddop.py +++ b/src/apideck_unify/models/sms_messagesaddop.py @@ -3,7 +3,7 @@ from __future__ import annotations from .createmessageresponse import CreateMessageResponse, CreateMessageResponseTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .message import MessageInput, MessageInputTypedDict +from .message_input import MessageInput, MessageInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/sms_messagesupdateop.py b/src/apideck_unify/models/sms_messagesupdateop.py index ad223a1b..1d1f0dd6 100644 --- a/src/apideck_unify/models/sms_messagesupdateop.py +++ b/src/apideck_unify/models/sms_messagesupdateop.py @@ -2,7 +2,7 @@ from __future__ import annotations from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict -from .message import MessageInput, MessageInputTypedDict +from .message_input import MessageInput, MessageInputTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, diff --git a/src/apideck_unify/models/subsidiary.py b/src/apideck_unify/models/subsidiary_input.py similarity index 100% rename from src/apideck_unify/models/subsidiary.py rename to src/apideck_unify/models/subsidiary_input.py index 4c783544..4742abf9 100644 --- a/src/apideck_unify/models/subsidiary.py +++ b/src/apideck_unify/models/subsidiary_input.py @@ -24,35 +24,20 @@ class SubsidiaryStatus(str, Enum): INACTIVE = "inactive" -class SubsidiaryTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" +class SubsidiaryInputTypedDict(TypedDict): parent_id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" name: NotRequired[Nullable[str]] r"""The name of the company.""" status: NotRequired[SubsidiaryStatus] r"""Based on the status some functionality is enabled or disabled.""" - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class Subsidiary(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - +class SubsidiaryInput(BaseModel): parent_id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" @@ -62,52 +47,16 @@ class Subsidiary(BaseModel): status: Optional[SubsidiaryStatus] = None r"""Based on the status some functionality is enabled or disabled.""" - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [ - "id", - "parent_id", - "name", - "status", - "custom_mappings", - "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", - "pass_through", - ] - nullable_fields = [ - "parent_id", - "name", - "custom_mappings", - "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", - ] + optional_fields = ["parent_id", "name", "status", "row_version", "pass_through"] + nullable_fields = ["parent_id", "name", "row_version"] null_default_fields = [] serialized = handler(self) @@ -135,20 +84,35 @@ def serialize_model(self, handler): return m -class SubsidiaryInputTypedDict(TypedDict): +class SubsidiaryTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" parent_id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" name: NotRequired[Nullable[str]] r"""The name of the company.""" status: NotRequired[SubsidiaryStatus] r"""Based on the status some functionality is enabled or disabled.""" + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class SubsidiaryInput(BaseModel): +class Subsidiary(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + parent_id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" @@ -158,16 +122,52 @@ class SubsidiaryInput(BaseModel): status: Optional[SubsidiaryStatus] = None r"""Based on the status some functionality is enabled or disabled.""" + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["parent_id", "name", "status", "row_version", "pass_through"] - nullable_fields = ["parent_id", "name", "row_version"] + optional_fields = [ + "id", + "parent_id", + "name", + "status", + "custom_mappings", + "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", + "pass_through", + ] + nullable_fields = [ + "parent_id", + "name", + "custom_mappings", + "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", + ] null_default_fields = [] serialized = handler(self) diff --git a/src/apideck_unify/models/taxrate.py b/src/apideck_unify/models/taxrate_input.py similarity index 100% rename from src/apideck_unify/models/taxrate.py rename to src/apideck_unify/models/taxrate_input.py index 435047e8..7c7150f3 100644 --- a/src/apideck_unify/models/taxrate.py +++ b/src/apideck_unify/models/taxrate_input.py @@ -83,7 +83,7 @@ class SubsidiariesModel(BaseModel): r"""The ID of the subsidiary.""" -class TaxRateTypedDict(TypedDict): +class TaxRateInputTypedDict(TypedDict): id: NotRequired[Nullable[str]] r"""ID assigned to identify this tax rate.""" name: NotRequired[str] @@ -109,18 +109,8 @@ class TaxRateTypedDict(TypedDict): r"""ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.""" status: NotRequired[Nullable[TaxRateStatus]] r"""Tax rate status""" - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" subsidiaries: NotRequired[List[SubsidiariesModelTypedDict]] @@ -128,7 +118,7 @@ class TaxRateTypedDict(TypedDict): custom_fields: NotRequired[List[CustomFieldTypedDict]] -class TaxRate(BaseModel): +class TaxRateInput(BaseModel): id: OptionalNullable[str] = UNSET r"""ID assigned to identify this tax rate.""" @@ -167,24 +157,9 @@ class TaxRate(BaseModel): status: OptionalNullable[TaxRateStatus] = UNSET r"""Tax rate status""" - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -209,12 +184,7 @@ def serialize_model(self, handler): "report_tax_type", "original_tax_rate_id", "status", - "custom_mappings", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", "subsidiaries", "custom_fields", @@ -232,12 +202,7 @@ def serialize_model(self, handler): "report_tax_type", "original_tax_rate_id", "status", - "custom_mappings", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -266,7 +231,7 @@ def serialize_model(self, handler): return m -class TaxRateInputTypedDict(TypedDict): +class TaxRateTypedDict(TypedDict): id: NotRequired[Nullable[str]] r"""ID assigned to identify this tax rate.""" name: NotRequired[str] @@ -292,8 +257,18 @@ class TaxRateInputTypedDict(TypedDict): r"""ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.""" status: NotRequired[Nullable[TaxRateStatus]] r"""Tax rate status""" + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" subsidiaries: NotRequired[List[SubsidiariesModelTypedDict]] @@ -301,7 +276,7 @@ class TaxRateInputTypedDict(TypedDict): custom_fields: NotRequired[List[CustomFieldTypedDict]] -class TaxRateInput(BaseModel): +class TaxRate(BaseModel): id: OptionalNullable[str] = UNSET r"""ID assigned to identify this tax rate.""" @@ -340,9 +315,24 @@ class TaxRateInput(BaseModel): status: OptionalNullable[TaxRateStatus] = UNSET r"""Tax rate status""" + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -367,7 +357,12 @@ def serialize_model(self, handler): "report_tax_type", "original_tax_rate_id", "status", + "custom_mappings", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", "subsidiaries", "custom_fields", @@ -385,7 +380,12 @@ def serialize_model(self, handler): "report_tax_type", "original_tax_rate_id", "status", + "custom_mappings", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/ticket.py b/src/apideck_unify/models/ticket_input.py similarity index 100% rename from src/apideck_unify/models/ticket.py rename to src/apideck_unify/models/ticket_input.py index e5932deb..4dca32af 100644 --- a/src/apideck_unify/models/ticket.py +++ b/src/apideck_unify/models/ticket_input.py @@ -30,13 +30,9 @@ class Priority(str, Enum): URGENT = "urgent" -class TicketTypedDict(TypedDict): - id: str - r"""A unique identifier for an object.""" +class TicketInputTypedDict(TypedDict): parent_id: NotRequired[Nullable[str]] r"""The ticket's parent ID""" - collection_id: NotRequired[Nullable[str]] - r"""The ticket's collection ID""" type: NotRequired[Nullable[str]] r"""The ticket's type""" subject: NotRequired[Nullable[str]] @@ -47,34 +43,18 @@ class TicketTypedDict(TypedDict): r"""The current status of the ticket. Possible values include: open, in_progress, closed, or - in cases where there is no clear mapping - the original value passed through.""" priority: NotRequired[Nullable[Priority]] r"""Priority of the ticket""" - assignees: NotRequired[List[AssigneeTypedDict]] - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" + assignees: NotRequired[List[AssigneeInputTypedDict]] due_date: NotRequired[Nullable[datetime]] r"""Due date of the ticket""" - completed_at: NotRequired[Nullable[datetime]] - r"""When the ticket was completed""" - tags: NotRequired[List[CollectionTagTypedDict]] - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" + tags: NotRequired[List[CollectionTagInputTypedDict]] pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class Ticket(BaseModel): - id: str - r"""A unique identifier for an object.""" - +class TicketInput(BaseModel): parent_id: OptionalNullable[str] = UNSET r"""The ticket's parent ID""" - collection_id: OptionalNullable[str] = UNSET - r"""The ticket's collection ID""" - type: OptionalNullable[str] = UNSET r"""The ticket's type""" @@ -90,27 +70,12 @@ class Ticket(BaseModel): priority: OptionalNullable[Priority] = UNSET r"""Priority of the ticket""" - assignees: Optional[List[Assignee]] = None - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" + assignees: Optional[List[AssigneeInput]] = None due_date: OptionalNullable[datetime] = UNSET r"""Due date of the ticket""" - completed_at: OptionalNullable[datetime] = UNSET - r"""When the ticket was completed""" - - tags: Optional[List[CollectionTag]] = None - - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" + tags: Optional[List[CollectionTagInput]] = None pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -119,36 +84,24 @@ class Ticket(BaseModel): def serialize_model(self, handler): optional_fields = [ "parent_id", - "collection_id", "type", "subject", "description", "status", "priority", "assignees", - "updated_at", - "created_at", - "created_by", "due_date", - "completed_at", "tags", - "custom_mappings", "pass_through", ] nullable_fields = [ "parent_id", - "collection_id", "type", "subject", "description", "status", "priority", - "updated_at", - "created_at", - "created_by", "due_date", - "completed_at", - "custom_mappings", ] null_default_fields = [] @@ -177,9 +130,13 @@ def serialize_model(self, handler): return m -class TicketInputTypedDict(TypedDict): +class TicketTypedDict(TypedDict): + id: str + r"""A unique identifier for an object.""" parent_id: NotRequired[Nullable[str]] r"""The ticket's parent ID""" + collection_id: NotRequired[Nullable[str]] + r"""The ticket's collection ID""" type: NotRequired[Nullable[str]] r"""The ticket's type""" subject: NotRequired[Nullable[str]] @@ -190,18 +147,34 @@ class TicketInputTypedDict(TypedDict): r"""The current status of the ticket. Possible values include: open, in_progress, closed, or - in cases where there is no clear mapping - the original value passed through.""" priority: NotRequired[Nullable[Priority]] r"""Priority of the ticket""" - assignees: NotRequired[List[AssigneeInputTypedDict]] + assignees: NotRequired[List[AssigneeTypedDict]] + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" due_date: NotRequired[Nullable[datetime]] r"""Due date of the ticket""" - tags: NotRequired[List[CollectionTagInputTypedDict]] + completed_at: NotRequired[Nullable[datetime]] + r"""When the ticket was completed""" + tags: NotRequired[List[CollectionTagTypedDict]] + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" -class TicketInput(BaseModel): +class Ticket(BaseModel): + id: str + r"""A unique identifier for an object.""" + parent_id: OptionalNullable[str] = UNSET r"""The ticket's parent ID""" + collection_id: OptionalNullable[str] = UNSET + r"""The ticket's collection ID""" + type: OptionalNullable[str] = UNSET r"""The ticket's type""" @@ -217,12 +190,27 @@ class TicketInput(BaseModel): priority: OptionalNullable[Priority] = UNSET r"""Priority of the ticket""" - assignees: Optional[List[AssigneeInput]] = None + assignees: Optional[List[Assignee]] = None + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" due_date: OptionalNullable[datetime] = UNSET r"""Due date of the ticket""" - tags: Optional[List[CollectionTagInput]] = None + completed_at: OptionalNullable[datetime] = UNSET + r"""When the ticket was completed""" + + tags: Optional[List[CollectionTag]] = None + + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -231,24 +219,36 @@ class TicketInput(BaseModel): def serialize_model(self, handler): optional_fields = [ "parent_id", + "collection_id", "type", "subject", "description", "status", "priority", "assignees", + "updated_at", + "created_at", + "created_by", "due_date", + "completed_at", "tags", + "custom_mappings", "pass_through", ] nullable_fields = [ "parent_id", + "collection_id", "type", "subject", "description", "status", "priority", + "updated_at", + "created_at", + "created_by", "due_date", + "completed_at", + "custom_mappings", ] null_default_fields = [] diff --git a/src/apideck_unify/models/timeoffrequest.py b/src/apideck_unify/models/timeoffrequest_input.py similarity index 100% rename from src/apideck_unify/models/timeoffrequest.py rename to src/apideck_unify/models/timeoffrequest_input.py index 54f0a863..88aa6922 100644 --- a/src/apideck_unify/models/timeoffrequest.py +++ b/src/apideck_unify/models/timeoffrequest_input.py @@ -89,9 +89,7 @@ def serialize_model(self, handler): return m -class TimeOffRequestTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" +class TimeOffRequestInputTypedDict(TypedDict): employee_id: NotRequired[Nullable[str]] r"""ID of the employee""" policy_id: NotRequired[Nullable[str]] @@ -117,26 +115,13 @@ class TimeOffRequestTypedDict(TypedDict): day_part: NotRequired[Nullable[str]] r"""The day part of the time off request.""" notes: NotRequired[NotesModelTypedDict] - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" policy_type: NotRequired[str] r"""The policy type of the time off request""" -class TimeOffRequest(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - +class TimeOffRequestInput(BaseModel): employee_id: OptionalNullable[str] = UNSET r"""ID of the employee""" @@ -175,21 +160,6 @@ class TimeOffRequest(BaseModel): notes: Optional[NotesModel] = None - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -199,7 +169,6 @@ class TimeOffRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", "employee_id", "policy_id", "status", @@ -213,11 +182,6 @@ def serialize_model(self, handler): "amount", "day_part", "notes", - "custom_mappings", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", "policy_type", ] @@ -234,11 +198,6 @@ def serialize_model(self, handler): "units", "amount", "day_part", - "custom_mappings", - "updated_by", - "created_by", - "updated_at", - "created_at", ] null_default_fields = [] @@ -267,7 +226,9 @@ def serialize_model(self, handler): return m -class TimeOffRequestInputTypedDict(TypedDict): +class TimeOffRequestTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" employee_id: NotRequired[Nullable[str]] r"""ID of the employee""" policy_id: NotRequired[Nullable[str]] @@ -293,13 +254,26 @@ class TimeOffRequestInputTypedDict(TypedDict): day_part: NotRequired[Nullable[str]] r"""The day part of the time off request.""" notes: NotRequired[NotesModelTypedDict] + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" policy_type: NotRequired[str] r"""The policy type of the time off request""" -class TimeOffRequestInput(BaseModel): +class TimeOffRequest(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + employee_id: OptionalNullable[str] = UNSET r"""ID of the employee""" @@ -338,6 +312,21 @@ class TimeOffRequestInput(BaseModel): notes: Optional[NotesModel] = None + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -347,6 +336,7 @@ class TimeOffRequestInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", "employee_id", "policy_id", "status", @@ -360,6 +350,11 @@ def serialize_model(self, handler): "amount", "day_part", "notes", + "custom_mappings", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", "policy_type", ] @@ -376,6 +371,11 @@ def serialize_model(self, handler): "units", "amount", "day_part", + "custom_mappings", + "updated_by", + "created_by", + "updated_at", + "created_at", ] null_default_fields = [] diff --git a/src/apideck_unify/models/trackingcategory.py b/src/apideck_unify/models/trackingcategory_input.py similarity index 100% rename from src/apideck_unify/models/trackingcategory.py rename to src/apideck_unify/models/trackingcategory_input.py index d6d49608..722795ac 100644 --- a/src/apideck_unify/models/trackingcategory.py +++ b/src/apideck_unify/models/trackingcategory_input.py @@ -34,9 +34,7 @@ class TrackingCategorySubsidiaries(BaseModel): r"""The ID of the subsidiary.""" -class TrackingCategoryTypedDict(TypedDict): - id: NotRequired[str] - r"""A unique identifier for an object.""" +class TrackingCategoryInputTypedDict(TypedDict): parent_id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" name: NotRequired[str] @@ -45,28 +43,15 @@ class TrackingCategoryTypedDict(TypedDict): r"""The code of the tracking category.""" status: NotRequired[TrackingCategoryStatus] r"""Based on the status some functionality is enabled or disabled.""" - custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] - r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: NotRequired[Nullable[str]] - r"""The user who last updated the object.""" - created_by: NotRequired[Nullable[str]] - r"""The user who created the object.""" - updated_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was last updated.""" - created_at: NotRequired[Nullable[datetime]] - r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" subsidiaries: NotRequired[List[TrackingCategorySubsidiariesTypedDict]] r"""The subsidiaries the account belongs to.""" -class TrackingCategory(BaseModel): - id: Optional[str] = None - r"""A unique identifier for an object.""" - +class TrackingCategoryInput(BaseModel): parent_id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" @@ -79,24 +64,9 @@ class TrackingCategory(BaseModel): status: Optional[TrackingCategoryStatus] = None r"""Based on the status some functionality is enabled or disabled.""" - custom_mappings: OptionalNullable[CustomMappings] = UNSET - r"""When custom mappings are configured on the resource, the result is included here.""" - row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" - updated_by: OptionalNullable[str] = UNSET - r"""The user who last updated the object.""" - - created_by: OptionalNullable[str] = UNSET - r"""The user who created the object.""" - - updated_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was last updated.""" - - created_at: OptionalNullable[datetime] = UNSET - r"""The date and time when the object was created.""" - pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -106,30 +76,15 @@ class TrackingCategory(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ - "id", "parent_id", "name", "code", "status", - "custom_mappings", "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", "pass_through", "subsidiaries", ] - nullable_fields = [ - "parent_id", - "code", - "custom_mappings", - "row_version", - "updated_by", - "created_by", - "updated_at", - "created_at", - ] + nullable_fields = ["parent_id", "code", "row_version"] null_default_fields = [] serialized = handler(self) @@ -157,7 +112,9 @@ def serialize_model(self, handler): return m -class TrackingCategoryInputTypedDict(TypedDict): +class TrackingCategoryTypedDict(TypedDict): + id: NotRequired[str] + r"""A unique identifier for an object.""" parent_id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" name: NotRequired[str] @@ -166,15 +123,28 @@ class TrackingCategoryInputTypedDict(TypedDict): r"""The code of the tracking category.""" status: NotRequired[TrackingCategoryStatus] r"""Based on the status some functionality is enabled or disabled.""" + custom_mappings: NotRequired[Nullable[CustomMappingsTypedDict]] + r"""When custom mappings are configured on the resource, the result is included here.""" row_version: NotRequired[Nullable[str]] r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: NotRequired[Nullable[str]] + r"""The user who last updated the object.""" + created_by: NotRequired[Nullable[str]] + r"""The user who created the object.""" + updated_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was last updated.""" + created_at: NotRequired[Nullable[datetime]] + r"""The date and time when the object was created.""" pass_through: NotRequired[List[PassThroughBodyTypedDict]] r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" subsidiaries: NotRequired[List[TrackingCategorySubsidiariesTypedDict]] r"""The subsidiaries the account belongs to.""" -class TrackingCategoryInput(BaseModel): +class TrackingCategory(BaseModel): + id: Optional[str] = None + r"""A unique identifier for an object.""" + parent_id: OptionalNullable[str] = UNSET r"""A unique identifier for an object.""" @@ -187,9 +157,24 @@ class TrackingCategoryInput(BaseModel): status: Optional[TrackingCategoryStatus] = None r"""Based on the status some functionality is enabled or disabled.""" + custom_mappings: OptionalNullable[CustomMappings] = UNSET + r"""When custom mappings are configured on the resource, the result is included here.""" + row_version: OptionalNullable[str] = UNSET r"""A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.""" + updated_by: OptionalNullable[str] = UNSET + r"""The user who last updated the object.""" + + created_by: OptionalNullable[str] = UNSET + r"""The user who created the object.""" + + updated_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was last updated.""" + + created_at: OptionalNullable[datetime] = UNSET + r"""The date and time when the object was created.""" + pass_through: Optional[List[PassThroughBody]] = None r"""The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.""" @@ -199,15 +184,30 @@ class TrackingCategoryInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "id", "parent_id", "name", "code", "status", + "custom_mappings", "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", "pass_through", "subsidiaries", ] - nullable_fields = ["parent_id", "code", "row_version"] + nullable_fields = [ + "parent_id", + "code", + "custom_mappings", + "row_version", + "updated_by", + "created_by", + "updated_at", + "created_at", + ] null_default_fields = [] serialized = handler(self) diff --git a/src/apideck_unify/models/unifiedfile.py b/src/apideck_unify/models/unifiedfile.py index 722bf7e1..dfb472df 100644 --- a/src/apideck_unify/models/unifiedfile.py +++ b/src/apideck_unify/models/unifiedfile.py @@ -156,10 +156,10 @@ def serialize_model(self, handler): "created_at", ] nullable_fields = [ - "name", - "type", "downstream_id", + "name", "description", + "type", "path", "mime_type", "size", diff --git a/src/apideck_unify/models/updateconnectionresponse.py b/src/apideck_unify/models/updateconnectionresponse.py index fa34c9cc..657a1001 100644 --- a/src/apideck_unify/models/updateconnectionresponse.py +++ b/src/apideck_unify/models/updateconnectionresponse.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .connection import Connection, ConnectionTypedDict +from .connection_input import Connection, ConnectionTypedDict from apideck_unify.types import ( BaseModel, Nullable, diff --git a/src/apideck_unify/models/vault_connectionsettingsupdateop.py b/src/apideck_unify/models/vault_connectionsettingsupdateop.py index 29674df6..979b7a3d 100644 --- a/src/apideck_unify/models/vault_connectionsettingsupdateop.py +++ b/src/apideck_unify/models/vault_connectionsettingsupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .connection import ConnectionInput, ConnectionInputTypedDict +from .connection_input import ConnectionInput, ConnectionInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/models/vault_connectionsupdateop.py b/src/apideck_unify/models/vault_connectionsupdateop.py index 0a0b0934..8f562a11 100644 --- a/src/apideck_unify/models/vault_connectionsupdateop.py +++ b/src/apideck_unify/models/vault_connectionsupdateop.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .connection import ConnectionInput, ConnectionInputTypedDict +from .connection_input import ConnectionInput, ConnectionInputTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, diff --git a/src/apideck_unify/notes.py b/src/apideck_unify/notes.py index 0457489e..55e764e8 100644 --- a/src/apideck_unify/notes.py +++ b/src/apideck_unify/notes.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -488,7 +488,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -672,7 +672,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -826,7 +826,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -980,7 +980,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1167,7 +1167,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1354,7 +1354,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1505,7 +1505,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1656,7 +1656,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/opportunities.py b/src/apideck_unify/opportunities.py index 46e74cb7..6e18f285 100644 --- a/src/apideck_unify/opportunities.py +++ b/src/apideck_unify/opportunities.py @@ -107,7 +107,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -306,7 +306,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -581,7 +581,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -829,7 +829,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -983,7 +983,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1137,7 +1137,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1388,7 +1388,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1639,7 +1639,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1790,7 +1790,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1941,7 +1941,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/orders.py b/src/apideck_unify/orders.py index a3ac50df..203de87e 100644 --- a/src/apideck_unify/orders.py +++ b/src/apideck_unify/orders.py @@ -104,7 +104,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -301,7 +301,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -482,7 +482,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -636,7 +636,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/payments.py b/src/apideck_unify/payments.py index 6c2d56dc..1d5f61d8 100644 --- a/src/apideck_unify/payments.py +++ b/src/apideck_unify/payments.py @@ -103,7 +103,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -298,7 +298,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -591,7 +591,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -857,7 +857,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1011,7 +1011,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1165,7 +1165,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1434,7 +1434,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1703,7 +1703,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1854,7 +1854,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2005,7 +2005,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/payrolls.py b/src/apideck_unify/payrolls.py index f4556258..df64b3af 100644 --- a/src/apideck_unify/payrolls.py +++ b/src/apideck_unify/payrolls.py @@ -92,7 +92,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -251,7 +251,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -405,7 +405,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -559,7 +559,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/pipelines.py b/src/apideck_unify/pipelines.py index 094cc7d8..5cb4867f 100644 --- a/src/apideck_unify/pipelines.py +++ b/src/apideck_unify/pipelines.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -492,7 +492,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -680,7 +680,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -834,7 +834,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -988,7 +988,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1179,7 +1179,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1370,7 +1370,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1521,7 +1521,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1672,7 +1672,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/products.py b/src/apideck_unify/products.py index c62e6e97..957d89b2 100644 --- a/src/apideck_unify/products.py +++ b/src/apideck_unify/products.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -458,7 +458,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -612,7 +612,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/profitandloss_sdk.py b/src/apideck_unify/profitandloss_sdk.py index b142887a..70975136 100644 --- a/src/apideck_unify/profitandloss_sdk.py +++ b/src/apideck_unify/profitandloss_sdk.py @@ -94,7 +94,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -255,7 +255,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/purchaseorders.py b/src/apideck_unify/purchaseorders.py index 40ec6eaa..6657bdf4 100644 --- a/src/apideck_unify/purchaseorders.py +++ b/src/apideck_unify/purchaseorders.py @@ -104,7 +104,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -299,7 +299,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -610,7 +610,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -895,7 +895,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1046,7 +1046,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1197,7 +1197,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1485,7 +1485,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1773,7 +1773,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1924,7 +1924,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2075,7 +2075,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/sessions.py b/src/apideck_unify/sessions.py index 9c10e2bd..0d7cf927 100644 --- a/src/apideck_unify/sessions.py +++ b/src/apideck_unify/sessions.py @@ -85,7 +85,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -237,7 +237,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/sharedlinks.py b/src/apideck_unify/sharedlinks.py index d16e35ec..25ce27cf 100644 --- a/src/apideck_unify/sharedlinks.py +++ b/src/apideck_unify/sharedlinks.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -476,7 +476,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -648,7 +648,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -802,7 +802,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -956,7 +956,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1131,7 +1131,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1306,7 +1306,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1457,7 +1457,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1608,7 +1608,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/stores.py b/src/apideck_unify/stores.py index d8bcbc21..82dc6a79 100644 --- a/src/apideck_unify/stores.py +++ b/src/apideck_unify/stores.py @@ -84,7 +84,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -235,7 +235,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/subsidiaries.py b/src/apideck_unify/subsidiaries.py index 9509278b..5cc63952 100644 --- a/src/apideck_unify/subsidiaries.py +++ b/src/apideck_unify/subsidiaries.py @@ -91,7 +91,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -272,7 +272,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -468,7 +468,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -640,7 +640,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -794,7 +794,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -948,7 +948,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1123,7 +1123,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1298,7 +1298,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1449,7 +1449,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1600,7 +1600,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/suppliers.py b/src/apideck_unify/suppliers.py index 39577fc4..fd4efa22 100644 --- a/src/apideck_unify/suppliers.py +++ b/src/apideck_unify/suppliers.py @@ -104,7 +104,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -301,7 +301,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -597,7 +597,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -866,7 +866,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1020,7 +1020,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1174,7 +1174,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1446,7 +1446,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1718,7 +1718,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1869,7 +1869,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -2020,7 +2020,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/taxrates.py b/src/apideck_unify/taxrates.py index debf9494..3d3759ce 100644 --- a/src/apideck_unify/taxrates.py +++ b/src/apideck_unify/taxrates.py @@ -100,7 +100,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -292,7 +292,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -540,7 +540,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -762,7 +762,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -917,7 +917,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1072,7 +1072,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1297,7 +1297,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1522,7 +1522,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1673,7 +1673,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1824,7 +1824,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/timeoffrequests.py b/src/apideck_unify/timeoffrequests.py index efac5a65..ef2a7a85 100644 --- a/src/apideck_unify/timeoffrequests.py +++ b/src/apideck_unify/timeoffrequests.py @@ -101,7 +101,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -294,7 +294,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -526,7 +526,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -732,7 +732,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -889,7 +889,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1046,7 +1046,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1258,7 +1258,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1470,7 +1470,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1624,7 +1624,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1778,7 +1778,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/trackingcategories.py b/src/apideck_unify/trackingcategories.py index 522c74ce..c38268a3 100644 --- a/src/apideck_unify/trackingcategories.py +++ b/src/apideck_unify/trackingcategories.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -493,7 +493,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -682,7 +682,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -836,7 +836,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -990,7 +990,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1182,7 +1182,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1374,7 +1374,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1525,7 +1525,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1676,7 +1676,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/uploadsessions.py b/src/apideck_unify/uploadsessions.py index fafd48fc..0bf1236d 100644 --- a/src/apideck_unify/uploadsessions.py +++ b/src/apideck_unify/uploadsessions.py @@ -110,7 +110,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -286,7 +286,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -440,7 +440,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -594,7 +594,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -761,7 +761,7 @@ def upload( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -928,7 +928,7 @@ async def upload_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1079,7 +1079,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1230,7 +1230,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1402,7 +1402,7 @@ def finish( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1574,7 +1574,7 @@ async def finish_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/users.py b/src/apideck_unify/users.py index 8d25bd61..98244a37 100644 --- a/src/apideck_unify/users.py +++ b/src/apideck_unify/users.py @@ -94,7 +94,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -279,7 +279,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -523,7 +523,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -742,7 +742,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -896,7 +896,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1050,7 +1050,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1272,7 +1272,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1494,7 +1494,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1645,7 +1645,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1796,7 +1796,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/validateconnection.py b/src/apideck_unify/validateconnection.py index cfb5f4fb..12076085 100644 --- a/src/apideck_unify/validateconnection.py +++ b/src/apideck_unify/validateconnection.py @@ -104,7 +104,7 @@ def state( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -275,7 +275,7 @@ async def state_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( diff --git a/src/apideck_unify/webhooks.py b/src/apideck_unify/webhooks.py index 1ed541f2..96b2de14 100644 --- a/src/apideck_unify/webhooks.py +++ b/src/apideck_unify/webhooks.py @@ -78,7 +78,7 @@ def list( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -242,7 +242,7 @@ async def list_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -424,7 +424,7 @@ def create( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -586,7 +586,7 @@ async def create_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -727,7 +727,7 @@ def get( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -868,7 +868,7 @@ async def get_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1030,7 +1030,7 @@ def update( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1192,7 +1192,7 @@ async def update_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( @@ -1333,7 +1333,7 @@ def delete( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( @@ -1474,7 +1474,7 @@ async def delete_async( retry_config = None if isinstance(retries, utils.RetryConfig): - retry_config = (retries, ["5XX"]) + retry_config = (retries, ["408", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext(