From 3f405e8ce9f6574004e17ac46ced0b19eb7a31b7 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 13 Aug 2025 12:40:36 +0000 Subject: [PATCH 1/2] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.603.0 --- .devcontainer/setup.sh | 1 + .speakeasy/gen.lock | 59 +++++---- .speakeasy/gen.yaml | 3 +- .speakeasy/workflow.lock | 16 +-- README.md | 12 +- RELEASES.md | 12 +- USAGE.md | 2 +- docs/models/applicant.md | 4 + docs/models/applicantgender.md | 14 ++ docs/models/applicantinput.md | 4 + docs/models/bill.md | 12 +- docs/models/billinput.md | 12 +- docs/models/billlineitem.md | 11 +- docs/models/billlineiteminput.md | 11 +- docs/models/billpayment.md | 2 +- docs/models/billpaymentinput.md | 2 +- docs/models/budget.md | 12 -- docs/models/creditnote.md | 3 +- docs/models/creditnoteinput.md | 3 +- docs/models/customer.md | 2 +- docs/models/customerinput.md | 2 +- docs/models/expense.md | 2 +- docs/models/expenseinput.md | 2 +- docs/models/invoice.md | 4 +- docs/models/invoiceinput.md | 4 +- docs/models/invoicelineitem.md | 3 +- docs/models/invoicelineiteminput.md | 3 +- docs/models/journalentry.md | 2 +- docs/models/journalentryinput.md | 2 +- docs/models/linkedattachment.md | 13 ++ docs/models/linkedworktag.md | 9 ++ docs/models/payment.md | 2 +- docs/models/paymentinput.md | 2 +- docs/models/purchaseorder.md | 5 +- docs/models/purchaseorderamortizationtype.md | 13 ++ docs/models/purchaseorderinput.md | 5 +- docs/models/quote.md | 3 +- docs/models/quoteinput.md | 3 +- docs/models/supplier.md | 2 +- docs/models/supplierinput.md | 2 +- docs/sdks/applicants/README.md | 12 +- docs/sdks/billpayments/README.md | 4 +- docs/sdks/bills/README.md | 54 ++++++-- docs/sdks/creditnotes/README.md | 10 +- docs/sdks/customers/README.md | 4 +- docs/sdks/expenses/README.md | 4 +- docs/sdks/invoices/README.md | 16 ++- docs/sdks/journalentries/README.md | 4 +- docs/sdks/payments/README.md | 4 +- docs/sdks/purchaseorders/README.md | 14 +- docs/sdks/quotes/README.md | 10 +- docs/sdks/suppliers/README.md | 4 +- poetry.toml | 1 + pyproject.toml | 3 +- scripts/publish.sh | 1 - src/apideck_unify/_version.py | 8 +- src/apideck_unify/applicants.py | 48 +++++++ src/apideck_unify/billpayments.py | 8 +- src/apideck_unify/bills.py | 132 ++++++++++++++++++- src/apideck_unify/creditnotes.py | 20 ++- src/apideck_unify/customers.py | 8 +- src/apideck_unify/expenses.py | 8 +- src/apideck_unify/invoices.py | 32 ++++- src/apideck_unify/journalentries.py | 8 +- src/apideck_unify/models/__init__.py | 31 ++++- src/apideck_unify/models/applicant.py | 60 +++++++++ src/apideck_unify/models/bill.py | 124 ++++++++++++++++- src/apideck_unify/models/billlineitem.py | 125 ++++++++++++++++++ src/apideck_unify/models/billpayment.py | 8 +- src/apideck_unify/models/creditnote.py | 22 +++- src/apideck_unify/models/customer.py | 8 +- src/apideck_unify/models/expense.py | 8 +- src/apideck_unify/models/invoice.py | 36 ++++- src/apideck_unify/models/invoicelineitem.py | 45 ++----- src/apideck_unify/models/journalentry.py | 8 +- src/apideck_unify/models/linkedattachment.py | 91 +++++++++++++ src/apideck_unify/models/linkedworktag.py | 58 ++++++++ src/apideck_unify/models/payment.py | 4 +- src/apideck_unify/models/payment_input.py | 4 +- src/apideck_unify/models/purchaseorder.py | 32 +++-- src/apideck_unify/models/quote.py | 22 +++- src/apideck_unify/models/supplier.py | 8 +- src/apideck_unify/payments.py | 8 +- src/apideck_unify/purchaseorders.py | 36 +++-- src/apideck_unify/quotes.py | 20 ++- src/apideck_unify/suppliers.py | 8 +- 86 files changed, 1192 insertions(+), 271 deletions(-) create mode 100644 docs/models/applicantgender.md delete mode 100644 docs/models/budget.md create mode 100644 docs/models/linkedattachment.md create mode 100644 docs/models/linkedworktag.md create mode 100644 docs/models/purchaseorderamortizationtype.md create mode 100644 src/apideck_unify/models/linkedattachment.py create mode 100644 src/apideck_unify/models/linkedworktag.py diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh index e543834f..8c59f725 100644 --- a/.devcontainer/setup.sh +++ b/.devcontainer/setup.sh @@ -7,6 +7,7 @@ curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/instal rmdir samples || true mkdir samples + python -m pip install --upgrade pip pip install -e . diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index b87c2683..b2df7469 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: b337846ec33a04af12cb4d495f0f9d97 - docVersion: 10.20.2 - speakeasyVersion: 1.598.3 - generationVersion: 2.674.3 - releaseVersion: 0.21.1 - configChecksum: 2a27991afe5d5da59aca04a7a80a730e + docChecksum: 755a7bf690701dcaff2d69af5977a8a4 + docVersion: 10.20.6 + speakeasyVersion: 1.603.0 + generationVersion: 2.681.1 + releaseVersion: 0.21.2 + configChecksum: 080e00c6416f6c9e45d426ee8baca832 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.19.7 + core: 5.19.8 deepObjectParams: 0.1.0 defaultEnabledRetries: 0.2.0 deprecations: 3.0.2 @@ -23,7 +23,7 @@ features: downloadStreams: 1.0.1 enumUnions: 0.1.0 envVarSecurityUsage: 0.3.2 - errors: 3.3.1 + errors: 3.3.2 flatRequests: 1.0.1 flattening: 3.1.1 globalSecurity: 3.0.3 @@ -422,6 +422,7 @@ generatedFiles: - docs/models/apistatus.md - docs/models/apitype.md - docs/models/applicant.md + - docs/models/applicantgender.md - docs/models/applicantinput.md - docs/models/applicantsfilter.md - docs/models/applicanttype.md @@ -507,7 +508,6 @@ generatedFiles: - docs/models/billstatus.md - docs/models/blocks.md - docs/models/branch.md - - docs/models/budget.md - docs/models/by.md - docs/models/categoriesfilter.md - docs/models/categoriesfiltertype.md @@ -1396,6 +1396,7 @@ generatedFiles: - docs/models/ledgeraccountssortby.md - docs/models/ledgeraccountsubsidiaries.md - docs/models/ledgeraccounttype.md + - docs/models/linkedattachment.md - docs/models/linkedconnectorresource.md - docs/models/linkedcustomer.md - docs/models/linkedcustomerinput.md @@ -1413,6 +1414,7 @@ generatedFiles: - docs/models/linkedtaxrate.md - docs/models/linkedtaxrateinput.md - docs/models/linkedtrackingcategory.md + - docs/models/linkedworktag.md - docs/models/links.md - docs/models/locationstatus.md - docs/models/log.md @@ -1487,6 +1489,7 @@ generatedFiles: - docs/models/profitandlosstype.md - docs/models/purchasedetails.md - docs/models/purchaseorder.md + - docs/models/purchaseorderamortizationtype.md - docs/models/purchaseorderinput.md - docs/models/purchaseordersfilter.md - docs/models/purchaseorderssort.md @@ -2595,6 +2598,7 @@ generatedFiles: - src/apideck_unify/models/ledgeraccount.py - src/apideck_unify/models/ledgeraccountsfilter.py - src/apideck_unify/models/ledgeraccountssort.py + - src/apideck_unify/models/linkedattachment.py - src/apideck_unify/models/linkedconnectorresource.py - src/apideck_unify/models/linkedcustomer.py - src/apideck_unify/models/linkedcustomer_input.py @@ -2611,6 +2615,7 @@ generatedFiles: - src/apideck_unify/models/linkedtaxrate.py - src/apideck_unify/models/linkedtaxrate_input.py - src/apideck_unify/models/linkedtrackingcategory.py + - src/apideck_unify/models/linkedworktag.py - src/apideck_unify/models/links.py - src/apideck_unify/models/log.py - src/apideck_unify/models/logsfilter.py @@ -3195,7 +3200,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": "INV-2024-001", "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"}], "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", "country": "US"}, "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": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} + application/json: {"display_id": "123456", "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", "department_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": "INV-2024-001", "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"}], "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", "country": "US"}, "discount_percentage": 5.5, "template_id": "123456", "approved_by": "John Doe", "tax_method": "Due to supplier", "document_received": true, "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": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24", "attachments": [{"name": "sample.jpg", "mime_type": "image/jpeg", "is_compressed": false, "encoding": "base64", "content": "data:image/jpeg;base64,...", "notes": "A sample image"}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "add", "data": {"id": "12345"}} @@ -3251,7 +3256,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": "INV-2024-001", "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", "country": "US"}, "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": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"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", "display_id": "123456", "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", "department_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": "INV-2024-001", "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", "country": "US"}, "discount_percentage": 5.5, "template_id": "123456", "approved_by": "John Doe", "tax_method": "Due to supplier", "document_received": true, "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": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24", "attachments": [{"name": "sample.jpg", "mime_type": "image/jpeg", "is_compressed": false, "encoding": "base64", "content": "data:image/jpeg;base64,...", "notes": "A sample image"}]}} "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": @@ -3303,7 +3308,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": "INV-2024-001", "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"}], "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", "country": "US"}, "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": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} + application/json: {"display_id": "123456", "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", "department_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": "INV-2024-001", "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"}], "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", "country": "US"}, "discount_percentage": 5.5, "template_id": "123456", "approved_by": "John Doe", "tax_method": "Due to supplier", "document_received": true, "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": "Uses Salesforce and Marketo"}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24", "attachments": [{"name": "sample.jpg", "mime_type": "image/jpeg", "is_compressed": false, "encoding": "base64", "content": "data:image/jpeg;base64,...", "notes": "A sample image"}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "update", "data": {"id": "12345"}} @@ -3462,7 +3467,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": "INV-2024-001", "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"}], "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"}], "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"}], "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_allocations": [{"id": "123456", "allocated_amount": 1000, "date": "2020-09-30T07:43:32.000Z"}], "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", "country": "US"}, "ledger_account": null, "custom_fields": [{"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"}}}]}]} + application/json: {"display_id": "123456", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "department_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "INV-2024-001", "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"}], "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"}], "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"}], "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_allocations": [{"id": "123456", "allocated_amount": 1000, "date": "2020-09-30T07:43:32.000Z"}], "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", "country": "US"}, "ledger_account": null, "custom_fields": [{"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"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "add", "data": {"id": "12345", "downstream_id": "12345"}} @@ -3518,7 +3523,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": null, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "INV-2024-001", "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"}], "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"}], "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_allocations": [{"id": "123456", "allocated_amount": 1000, "date": "2020-09-30T07:43:32.000Z"}], "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", "country": "US"}, "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"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "display_id": "123456", "type": "service", "number": "OIT00546", "customer": null, "company_id": "12345", "department_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "INV-2024-001", "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"}], "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"}], "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_allocations": [{"id": "123456", "allocated_amount": 1000, "date": "2020-09-30T07:43:32.000Z"}], "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", "country": "US"}, "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"}}}]}]}} "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": @@ -3570,7 +3575,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": "INV-2024-001", "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"}], "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": null, "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"}], "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_allocations": [{"id": "123456", "allocated_amount": 1000, "date": "2020-09-30T07:43:32.000Z"}], "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", "country": "US"}, "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", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"display_id": "123456", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "department_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "INV-2024-001", "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"}], "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": null, "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"}], "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_allocations": [{"id": "123456", "allocated_amount": 1000, "date": "2020-09-30T07:43:32.000Z"}], "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", "country": "US"}, "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", "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": "invoices", "operation": "update", "data": {"id": "12345", "downstream_id": "12345"}} @@ -4265,7 +4270,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": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": null, "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"}], "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"}], "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", "department_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": null, "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"}], "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"}], "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"}} @@ -4321,7 +4326,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": "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": null, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": null}], "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": null}], "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"}}}]}]}} + 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", "department_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": null, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": null}], "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": null}], "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"}}}]}]}} "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": @@ -4373,7 +4378,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": "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": null}], "row_version": "1-12345"}], "allocations": [{"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"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": null}], "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", "department_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"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": null}], "row_version": "1-12345"}], "allocations": [{"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"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": null}], "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": "credit-notes", "operation": "update", "data": {"id": "12345"}} @@ -5751,7 +5756,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"}}, "subsidiary_id": "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"}], "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"}], "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"}, "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", "country": "US"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "terms": "Net 30 days", "tax_code": "1234", "tax_method": "Due to supplier", "issued_method": "Email", "issued_email": "john.doe@example.com", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "notes": "This is a test purchase order", "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"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"}}}]}]} + 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"}}, "subsidiary_id": "12345", "company_id": "12345", "department_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"}], "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"}], "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"}, "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", "country": "US"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "terms": "Net 30 days", "tax_code": "1234", "tax_method": "Due to supplier", "issued_method": "Email", "issued_email": "john.doe@example.com", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "notes": "This is a test purchase order", "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"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"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "add", "data": {"id": "12345"}} @@ -5805,7 +5810,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"}}, "subsidiary_id": "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": null, "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"}, "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", "country": "US"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "terms": "Net 30 days", "tax_code": "1234", "tax_method": "Due to supplier", "issued_method": "Email", "issued_email": "john.doe@example.com", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "notes": "This is a test purchase order", "tracking_categories": [{"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"}}}]}]}} + 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"}}, "subsidiary_id": "12345", "company_id": "12345", "department_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": null, "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"}, "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", "country": "US"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "terms": "Net 30 days", "tax_code": "1234", "tax_method": "Due to supplier", "issued_method": "Email", "issued_email": "john.doe@example.com", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "notes": "This is a test purchase order", "tracking_categories": [{"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"}}}]}]}} "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": @@ -5857,7 +5862,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"}}, "subsidiary_id": "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"}], "ledger_account": null, "custom_fields": [{"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"}, "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", "country": "US"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "terms": "Net 30 days", "tax_code": "1234", "tax_method": "Due to supplier", "issued_method": "Email", "issued_email": "john.doe@example.com", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "notes": "This is a test purchase order", "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"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"}}}]}]} + 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"}}, "subsidiary_id": "12345", "company_id": "12345", "department_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"}], "ledger_account": null, "custom_fields": [{"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"}, "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", "country": "US"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "terms": "Net 30 days", "tax_code": "1234", "tax_method": "Due to supplier", "issued_method": "Email", "issued_email": "john.doe@example.com", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "notes": "This is a test purchase order", "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"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"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "update", "data": {"id": "12345"}} @@ -8636,7 +8641,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"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 ...", "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": null}], "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"}], "websites": [{"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"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "owner_id": "54321", "record_url": "https://app.intercom.io/contacts/12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "salutation": "Mr", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "gender": "male", "social_security_number": "123456789", "type": "Candidate", "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": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": null}], "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"}], "websites": [{"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"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "owner_id": "54321", "record_url": "https://app.intercom.io/contacts/12345", "deleted": true, "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": "lever", "resource": "Applicants", "operation": "add", "data": {"id": "12345"}} @@ -8692,7 +8697,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "one", "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"}], "custom_fields": [{"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"}], "websites": [{"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"], "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"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "one", "data": {"id": "12345", "name": "Elon Musk", "salutation": "Mr", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "gender": "male", "social_security_number": "123456789", "type": "Candidate", "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": "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"}], "websites": [{"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"], "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"}}}]}]}} "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": @@ -8744,7 +8749,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"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 ...", "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": "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"}], "websites": [{"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"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "owner_id": "54321", "record_url": "https://app.intercom.io/contacts/12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "salutation": "Mr", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "gender": "male", "social_security_number": "123456789", "type": "Candidate", "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": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"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"}], "websites": [{"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"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "owner_id": "54321", "record_url": "https://app.intercom.io/contacts/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": "lever", "resource": "Applicants", "operation": "update", "data": {"id": "12345"}} @@ -17910,7 +17915,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "QT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "sales_order_id": "123456", "company_id": "12345", "project_id": "12345", "quote_date": "2020-09-30", "expiry_date": "2020-10-30", "terms": "Valid for 30 days", "reference": "INV-2024-001", "status": "draft", "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, "customer_memo": "Thank you for considering our services!", "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, "category_id": "12345", "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", "parent_id": "123456", "parent_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"}], "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", "parent_id": "123456", "parent_name": "New York"}], "template_id": "123456", "source_document_url": "https://www.quotesolution.com/quote/123456", "custom_fields": [{"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"}}}]}]} + application/json: {"number": "QT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "sales_order_id": "123456", "company_id": "12345", "department_id": "12345", "project_id": "12345", "quote_date": "2020-09-30", "expiry_date": "2020-10-30", "terms": "Valid for 30 days", "reference": "INV-2024-001", "status": "draft", "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, "customer_memo": "Thank you for considering our services!", "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, "category_id": "12345", "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", "parent_id": "123456", "parent_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"}], "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", "parent_id": "123456", "parent_name": "New York"}], "template_id": "123456", "source_document_url": "https://www.quotesolution.com/quote/123456", "custom_fields": [{"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"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Quotes", "operation": "add", "data": {"id": "12345"}} @@ -17939,7 +17944,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Quotes", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "number": "QT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "invoice_id": "123456", "sales_order_id": "123456", "company_id": "12345", "project_id": "12345", "quote_date": "2020-09-30", "expiry_date": "2020-10-30", "terms": "Valid for 30 days", "reference": "INV-2024-001", "status": "draft", "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, "customer_memo": "Thank you for considering our services!", "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, "category_id": "12345", "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", "parent_id": "123456", "parent_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"}, "tracking_categories": [{"id": "123456", "name": "New York", "parent_id": "123456", "parent_name": "New York"}], "template_id": "123456", "source_document_url": "https://www.quotesolution.com/quote/123456", "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"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Quotes", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "number": "QT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "invoice_id": "123456", "sales_order_id": "123456", "company_id": "12345", "department_id": "12345", "project_id": "12345", "quote_date": "2020-09-30", "expiry_date": "2020-10-30", "terms": "Valid for 30 days", "reference": "INV-2024-001", "status": "draft", "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, "customer_memo": "Thank you for considering our services!", "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, "category_id": "12345", "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", "parent_id": "123456", "parent_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"}, "tracking_categories": [{"id": "123456", "name": "New York", "parent_id": "123456", "parent_name": "New York"}], "template_id": "123456", "source_document_url": "https://www.quotesolution.com/quote/123456", "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"}}}]}]}} "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": @@ -17964,7 +17969,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "QT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "sales_order_id": "123456", "company_id": "12345", "project_id": "12345", "quote_date": "2020-09-30", "expiry_date": "2020-10-30", "terms": "Valid for 30 days", "reference": "INV-2024-001", "status": "draft", "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, "customer_memo": "Thank you for considering our services!", "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, "category_id": "12345", "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": null, "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"}], "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", "parent_id": "123456", "parent_name": "New York"}], "template_id": "123456", "source_document_url": "https://www.quotesolution.com/quote/123456", "custom_fields": [{"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"}}}]}]} + application/json: {"number": "QT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "sales_order_id": "123456", "company_id": "12345", "department_id": "12345", "project_id": "12345", "quote_date": "2020-09-30", "expiry_date": "2020-10-30", "terms": "Valid for 30 days", "reference": "INV-2024-001", "status": "draft", "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, "customer_memo": "Thank you for considering our services!", "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, "category_id": "12345", "location_id": "12345", "department_id": "12345", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": null, "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"}], "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", "parent_id": "123456", "parent_name": "New York"}], "template_id": "123456", "source_document_url": "https://www.quotesolution.com/quote/123456", "custom_fields": [{"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"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Quotes", "operation": "update", "data": {"id": "12345"}} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index c21b0f9c..8a61eeab 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -24,7 +24,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false python: - version: 0.21.1 + version: 0.21.2 additionalDependencies: dev: {} main: {} @@ -55,6 +55,7 @@ python: methodArguments: infer-optional-args moduleName: "" outputModelSuffix: output + packageManager: poetry packageName: apideck-unify pytestFilterWarnings: [] pytestTimeout: 0 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 32a8a84d..c7e372ad 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.598.3 +speakeasyVersion: 1.603.0 sources: Apideck: sourceNamespace: apideck - sourceRevisionDigest: sha256:1bafb12d822c777307f2b0a7ebe91c01e15b76fa8cf23d28248d4066f09ad921 - sourceBlobDigest: sha256:9e52c2394423567942ea5e54f9e7c86a1d7659416baa2b37e58d7807ac742d4f + sourceRevisionDigest: sha256:b801725aed539ed127d4726499985ca7a6d5a7d460b173cf77aca9d016f92f57 + sourceBlobDigest: sha256:34486f16ce3b18f16a5a808feaf9a57babbaddfb98530f857fbcbf9d808c78f5 tags: - latest - - speakeasy-sdk-regen-1754482738 - - 10.20.2 + - speakeasy-sdk-regen-1754600536 + - 10.20.6 targets: apideck: source: Apideck sourceNamespace: apideck - sourceRevisionDigest: sha256:1bafb12d822c777307f2b0a7ebe91c01e15b76fa8cf23d28248d4066f09ad921 - sourceBlobDigest: sha256:9e52c2394423567942ea5e54f9e7c86a1d7659416baa2b37e58d7807ac742d4f + sourceRevisionDigest: sha256:b801725aed539ed127d4726499985ca7a6d5a7d460b173cf77aca9d016f92f57 + sourceBlobDigest: sha256:34486f16ce3b18f16a5a808feaf9a57babbaddfb98530f857fbcbf9d808c78f5 codeSamplesNamespace: apideck-python-code-samples - codeSamplesRevisionDigest: sha256:983da19a0ac8413344b9dbccff34a180cc8a7d77ead550719c50534b091f08cc + codeSamplesRevisionDigest: sha256:6fc159d2d6f38cd30788386f794875bba59a0be2567d07f1090ad7fce427d8a8 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 6e1af856..b66cd29c 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,15 @@ For more information about the API: [Apideck Developer Docs](https://developers. > > Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated. -The SDK can be installed with either *pip* or *poetry* package managers. +The SDK can be installed with *uv*, *pip*, or *poetry* package managers. + +### uv + +*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities. + +```bash +uv add apideck-unify +``` ### PIP @@ -144,7 +152,7 @@ with Apideck(
-The same SDK client can also be used to make asychronous requests by importing asyncio. +The same SDK client can also be used to make asynchronous requests by importing asyncio. ```python # Asynchronous Example from apideck_unify import Apideck diff --git a/RELEASES.md b/RELEASES.md index 13e4977c..c8c49e8e 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -388,4 +388,14 @@ Based on: ### Generated - [python v0.21.1] . ### Releases -- [PyPI v0.21.1] https://pypi.org/project/apideck-unify/0.21.1 - . \ No newline at end of file +- [PyPI v0.21.1] https://pypi.org/project/apideck-unify/0.21.1 - . + +## 2025-08-13 12:37:35 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.603.0 (2.681.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.21.2] . +### Releases +- [PyPI v0.21.2] https://pypi.org/project/apideck-unify/0.21.2 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 9d2ed5af..bd367cb2 100644 --- a/USAGE.md +++ b/USAGE.md @@ -29,7 +29,7 @@ with Apideck(
-The same SDK client can also be used to make asychronous requests by importing asyncio. +The same SDK client can also be used to make asynchronous requests by importing asyncio. ```python # Asynchronous Example from apideck_unify import Apideck diff --git a/docs/models/applicant.md b/docs/models/applicant.md index 860eeba2..c89b0827 100644 --- a/docs/models/applicant.md +++ b/docs/models/applicant.md @@ -7,11 +7,15 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | +| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | | `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM | | `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 | +| `gender` | [OptionalNullable[models.ApplicantGender]](../models/applicantgender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male | +| `social_security_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. | 123456789 | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | Candidate | | `cover_letter` | *Optional[str]* | :heavy_minus_sign: | N/A | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://democompany.recruitee.com/o/example-talent-pool | | `photo_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk | diff --git a/docs/models/applicantgender.md b/docs/models/applicantgender.md new file mode 100644 index 00000000..e3cf3251 --- /dev/null +++ b/docs/models/applicantgender.md @@ -0,0 +1,14 @@ +# ApplicantGender + +The gender represents the gender identity of a person. + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `MALE` | male | +| `FEMALE` | female | +| `UNISEX` | unisex | +| `OTHER` | other | +| `NOT_SPECIFIED` | not_specified | \ No newline at end of file diff --git a/docs/models/applicantinput.md b/docs/models/applicantinput.md index 1b74692c..0b7e6085 100644 --- a/docs/models/applicantinput.md +++ b/docs/models/applicantinput.md @@ -6,11 +6,15 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | +| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | | `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM | | `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 | +| `gender` | [OptionalNullable[models.ApplicantGender]](../models/applicantgender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male | +| `social_security_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. | 123456789 | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | Candidate | | `cover_letter` | *Optional[str]* | :heavy_minus_sign: | N/A | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk | | `headline` | *Optional[str]* | :heavy_minus_sign: | Typically a list of previous companies where the contact has worked or schools that the contact has attended | PepsiCo, Inc, Central Perk | diff --git a/docs/models/bill.md b/docs/models/bill.md index e6823a3e..1df4248d 100644 --- a/docs/models/bill.md +++ b/docs/models/bill.md @@ -7,9 +7,11 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `downstream_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | @@ -35,6 +37,11 @@ | `accounting_by_row` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. | false | | `bank_account` | [Optional[models.BankAccount]](../models/bankaccount.md) | :heavy_minus_sign: | N/A | | | `discount_percentage` | *OptionalNullable[float]* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 | +| `template_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional bill template | 123456 | +| `approved_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who approved the bill | John Doe | +| `amortization_type` | [OptionalNullable[models.AmortizationType]](../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | +| `document_received` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the document has been received | true | | `source_document_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. | https://www.invoicesolution.com/bill/123456 | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `updated_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who last updated the object. | 12345 | @@ -45,4 +52,5 @@ | `custom_fields` | List[[models.CustomField](../models/customfield.md)] | :heavy_minus_sign: | N/A | | | `custom_mappings` | Dict[str, *Any*] | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | | `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. | | -| `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 | \ No newline at end of file +| `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 | +| `attachments` | List[[Nullable[models.LinkedAttachment]](../models/linkedattachment.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/billinput.md b/docs/models/billinput.md index a70c7516..b22d4efb 100644 --- a/docs/models/billinput.md +++ b/docs/models/billinput.md @@ -5,9 +5,11 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | @@ -33,9 +35,15 @@ | `accounting_by_row` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. | false | | `bank_account` | [Optional[models.BankAccount]](../models/bankaccount.md) | :heavy_minus_sign: | N/A | | | `discount_percentage` | *OptionalNullable[float]* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 | +| `template_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional bill template | 123456 | +| `approved_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who approved the bill | John Doe | +| `amortization_type` | [OptionalNullable[models.AmortizationType]](../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | +| `document_received` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the document has been received | true | | `source_document_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. | https://www.invoicesolution.com/bill/123456 | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `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 | | `custom_fields` | List[[models.CustomField](../models/customfield.md)] | :heavy_minus_sign: | 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. | | -| `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 | \ No newline at end of file +| `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 | +| `attachments` | List[[Nullable[models.LinkedAttachment]](../models/linkedattachment.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/billlineitem.md b/docs/models/billlineitem.md index f0c30b63..f584f65c 100644 --- a/docs/models/billlineitem.md +++ b/docs/models/billlineitem.md @@ -22,6 +22,14 @@ | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | | `category_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the category of the line item | 12345 | +| `shipping_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the shipping of the line item | 12345 | +| `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | Memo | Some memo | +| `prepaid` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the line item is prepaid | true | +| `tax_applicable_on` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | +| `tax_recoverability` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | +| `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | +| `retention_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Retention amount | 1000 | +| `payment_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Payment amount | 1000 | | `item` | [Optional[models.LinkedInvoiceItem]](../models/linkedinvoiceitem.md) | :heavy_minus_sign: | N/A | | | `tax_rate` | [Optional[models.LinkedTaxRate]](../models/linkedtaxrate.md) | :heavy_minus_sign: | N/A | | | `ledger_account` | [OptionalNullable[models.LinkedLedgerAccount]](../models/linkedledgeraccount.md) | :heavy_minus_sign: | N/A | | @@ -33,4 +41,5 @@ | `updated_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who last updated the object. | 12345 | | `created_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who created the object. | 12345 | | `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 | -| `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 | \ No newline at end of file +| `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 | +| `worktags` | List[[Nullable[models.LinkedWorktag]](../models/linkedworktag.md)] | :heavy_minus_sign: | A list of linked worktags. This is only supported for Workday. | | \ No newline at end of file diff --git a/docs/models/billlineiteminput.md b/docs/models/billlineiteminput.md index e2903513..62ba4d44 100644 --- a/docs/models/billlineiteminput.md +++ b/docs/models/billlineiteminput.md @@ -21,6 +21,14 @@ | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | | `category_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the category of the line item | 12345 | +| `shipping_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the shipping of the line item | 12345 | +| `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | Memo | Some memo | +| `prepaid` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the line item is prepaid | true | +| `tax_applicable_on` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | +| `tax_recoverability` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | +| `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | +| `retention_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Retention amount | 1000 | +| `payment_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | Payment amount | 1000 | | `item` | [Optional[models.LinkedInvoiceItem]](../models/linkedinvoiceitem.md) | :heavy_minus_sign: | N/A | | | `tax_rate` | [Optional[models.LinkedTaxRateInput]](../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | | | `ledger_account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | @@ -28,4 +36,5 @@ | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `rebilling` | [OptionalNullable[models.Rebilling]](../models/rebilling.md) | :heavy_minus_sign: | Rebilling metadata for this line item. | | -| `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 | \ No newline at end of file +| `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 | +| `worktags` | List[[Nullable[models.LinkedWorktag]](../models/linkedworktag.md)] | :heavy_minus_sign: | A list of linked worktags. This is only supported for Workday. | | \ No newline at end of file diff --git a/docs/models/billpayment.md b/docs/models/billpayment.md index ddb45bbf..8cd05893 100644 --- a/docs/models/billpayment.md +++ b/docs/models/billpayment.md @@ -17,7 +17,7 @@ | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.BillPaymentType]](../models/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable | diff --git a/docs/models/billpaymentinput.md b/docs/models/billpaymentinput.md index 2db0f6f3..71625d5b 100644 --- a/docs/models/billpaymentinput.md +++ b/docs/models/billpaymentinput.md @@ -15,7 +15,7 @@ | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.BillPaymentType]](../models/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable | diff --git a/docs/models/budget.md b/docs/models/budget.md deleted file mode 100644 index 7268601d..00000000 --- a/docs/models/budget.md +++ /dev/null @@ -1,12 +0,0 @@ -# Budget - -Budget of the line item - - -## Values - -| Name | Value | -| --------------- | --------------- | -| `OUT_OF_BUDGET` | out_of_budget | -| `IN_BUDGET` | in_budget | -| `OTHER` | other | \ No newline at end of file diff --git a/docs/models/creditnote.md b/docs/models/creditnote.md index 2a058a78..4ab51fb2 100644 --- a/docs/models/creditnote.md +++ b/docs/models/creditnote.md @@ -8,7 +8,8 @@ | `id` | *str* | :heavy_check_mark: | Unique identifier representing the entity | 123456 | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | diff --git a/docs/models/creditnoteinput.md b/docs/models/creditnoteinput.md index 0280ba26..c8a597e9 100644 --- a/docs/models/creditnoteinput.md +++ b/docs/models/creditnoteinput.md @@ -7,7 +7,8 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | diff --git a/docs/models/customer.md b/docs/models/customer.md index d95fecb5..0465938a 100644 --- a/docs/models/customer.md +++ b/docs/models/customer.md @@ -10,7 +10,7 @@ | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | diff --git a/docs/models/customerinput.md b/docs/models/customerinput.md index 1c94f0c4..f87dcb19 100644 --- a/docs/models/customerinput.md +++ b/docs/models/customerinput.md @@ -8,7 +8,7 @@ | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | diff --git a/docs/models/expense.md b/docs/models/expense.md index 1ca9745f..597969a0 100644 --- a/docs/models/expense.md +++ b/docs/models/expense.md @@ -11,7 +11,7 @@ | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `payment_type` | [OptionalNullable[models.ExpensePaymentType]](../models/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash | | `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 | diff --git a/docs/models/expenseinput.md b/docs/models/expenseinput.md index ff304d87..7ea60d16 100644 --- a/docs/models/expenseinput.md +++ b/docs/models/expenseinput.md @@ -10,7 +10,7 @@ | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `payment_type` | [OptionalNullable[models.ExpensePaymentType]](../models/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash | | `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 | diff --git a/docs/models/invoice.md b/docs/models/invoice.md index 68055493..0051b56f 100644 --- a/docs/models/invoice.md +++ b/docs/models/invoice.md @@ -7,10 +7,12 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `downstream_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `type` | [OptionalNullable[models.InvoiceType]](../models/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Invoice 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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `invoice_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date invoice was issued - YYYY-MM-DD. | 2020-09-30 | | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. | 2020-09-30 | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | diff --git a/docs/models/invoiceinput.md b/docs/models/invoiceinput.md index 048495df..5a228a87 100644 --- a/docs/models/invoiceinput.md +++ b/docs/models/invoiceinput.md @@ -5,10 +5,12 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `type` | [OptionalNullable[models.InvoiceType]](../models/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Invoice 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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `invoice_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date invoice was issued - YYYY-MM-DD. | 2020-09-30 | | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. | 2020-09-30 | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | diff --git a/docs/models/invoicelineitem.md b/docs/models/invoicelineitem.md index fddee3e6..19cdc08f 100644 --- a/docs/models/invoicelineitem.md +++ b/docs/models/invoicelineitem.md @@ -29,8 +29,7 @@ | `tax_applicable_on` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | | `tax_recoverability` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | | `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | -| `budget` | [OptionalNullable[models.Budget]](../models/budget.md) | :heavy_minus_sign: | Budget of the line item | in_budget | -| `project_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the project of the line item | 12345 | +| `worktags` | List[[Nullable[models.LinkedWorktag]](../models/linkedworktag.md)] | :heavy_minus_sign: | Worktags of the line item. This is currently only supported in Workday. | | | `tax_rate` | [Optional[models.LinkedTaxRate]](../models/linkedtaxrate.md) | :heavy_minus_sign: | N/A | | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `ledger_account` | [OptionalNullable[models.LinkedLedgerAccount]](../models/linkedledgeraccount.md) | :heavy_minus_sign: | N/A | | diff --git a/docs/models/invoicelineiteminput.md b/docs/models/invoicelineiteminput.md index a25b23e3..692f9e25 100644 --- a/docs/models/invoicelineiteminput.md +++ b/docs/models/invoicelineiteminput.md @@ -29,8 +29,7 @@ | `tax_applicable_on` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | | `tax_recoverability` | *OptionalNullable[str]* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | | `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | -| `budget` | [OptionalNullable[models.Budget]](../models/budget.md) | :heavy_minus_sign: | Budget of the line item | in_budget | -| `project_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the project of the line item | 12345 | +| `worktags` | List[[Nullable[models.LinkedWorktag]](../models/linkedworktag.md)] | :heavy_minus_sign: | Worktags of the line item. This is currently only supported in Workday. | | | `tax_rate` | [Optional[models.LinkedTaxRateInput]](../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `ledger_account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | diff --git a/docs/models/journalentry.md b/docs/models/journalentry.md index 70f8a82d..85327445 100644 --- a/docs/models/journalentry.md +++ b/docs/models/journalentry.md @@ -9,7 +9,7 @@ | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `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 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `line_items` | List[[models.JournalEntryLineItem](../models/journalentrylineitem.md)] | :heavy_minus_sign: | Requires a minimum of 2 line items that sum to 0 | | | `status` | [OptionalNullable[models.JournalEntryStatus]](../models/journalentrystatus.md) | :heavy_minus_sign: | Journal entry status | draft | | `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference for the journal entry. | Thank you for your business and have a great day! | diff --git a/docs/models/journalentryinput.md b/docs/models/journalentryinput.md index 2e1ea530..015be75b 100644 --- a/docs/models/journalentryinput.md +++ b/docs/models/journalentryinput.md @@ -8,7 +8,7 @@ | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `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 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `line_items` | List[[models.JournalEntryLineItemInput](../models/journalentrylineiteminput.md)] | :heavy_minus_sign: | Requires a minimum of 2 line items that sum to 0 | | | `status` | [OptionalNullable[models.JournalEntryStatus]](../models/journalentrystatus.md) | :heavy_minus_sign: | Journal entry status | draft | | `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference for the journal entry. | Thank you for your business and have a great day! | diff --git a/docs/models/linkedattachment.md b/docs/models/linkedattachment.md new file mode 100644 index 00000000..7e763523 --- /dev/null +++ b/docs/models/linkedattachment.md @@ -0,0 +1,13 @@ +# LinkedAttachment + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | +| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the file | sample.jpg | +| `mime_type` | *OptionalNullable[str]* | :heavy_minus_sign: | The MIME type of the file. | image/jpeg | +| `is_compressed` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the file is c ompressed. | false | +| `encoding` | *OptionalNullable[str]* | :heavy_minus_sign: | The encoding of the file. | base64 | +| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | The content of the file. | data:image/jpeg;base64,... | +| `notes` | *OptionalNullable[str]* | :heavy_minus_sign: | The notes of the file. | A sample image | \ No newline at end of file diff --git a/docs/models/linkedworktag.md b/docs/models/linkedworktag.md new file mode 100644 index 00000000..38898f2e --- /dev/null +++ b/docs/models/linkedworktag.md @@ -0,0 +1,9 @@ +# LinkedWorktag + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the worktag. | 123456 | +| `value` | *OptionalNullable[str]* | :heavy_minus_sign: | The value of the worktag. | New York | \ No newline at end of file diff --git a/docs/models/payment.md b/docs/models/payment.md index 154fd15a..6228ed8c 100644 --- a/docs/models/payment.md +++ b/docs/models/payment.md @@ -20,7 +20,7 @@ | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.PaymentType]](../models/paymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable | diff --git a/docs/models/paymentinput.md b/docs/models/paymentinput.md index c31de53d..fe96fb0d 100644 --- a/docs/models/paymentinput.md +++ b/docs/models/paymentinput.md @@ -18,7 +18,7 @@ | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.PaymentType]](../models/paymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable | diff --git a/docs/models/purchaseorder.md b/docs/models/purchaseorder.md index d2ca896c..91cd23ec 100644 --- a/docs/models/purchaseorder.md +++ b/docs/models/purchaseorder.md @@ -11,7 +11,8 @@ | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional purchase order reference. | 123456 | | `supplier` | [OptionalNullable[models.LinkedSupplier]](../models/linkedsupplier.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `status` | [OptionalNullable[models.PurchaseOrderStatus]](../models/purchaseorderstatus.md) | :heavy_minus_sign: | N/A | open | | `issued_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date purchase order was issued - YYYY-MM-DD. | 2020-09-30 | | `delivery_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date on which the purchase order is to be delivered - YYYY-MM-DD. | 2020-09-30 | @@ -33,7 +34,7 @@ | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | -| `amortization_type` | [OptionalNullable[models.AmortizationType]](../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `amortization_type` | [OptionalNullable[models.PurchaseOrderAmortizationType]](../models/purchaseorderamortizationtype.md) | :heavy_minus_sign: | Type of amortization | | | `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | | `issued_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of issuance of the purchase order | Email | diff --git a/docs/models/purchaseorderamortizationtype.md b/docs/models/purchaseorderamortizationtype.md new file mode 100644 index 00000000..5a1acb9b --- /dev/null +++ b/docs/models/purchaseorderamortizationtype.md @@ -0,0 +1,13 @@ +# PurchaseOrderAmortizationType + +Type of amortization + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `MANUAL` | manual | +| `RECEIPT` | receipt | +| `SCHEDULE` | schedule | +| `OTHER` | other | \ No newline at end of file diff --git a/docs/models/purchaseorderinput.md b/docs/models/purchaseorderinput.md index a031935a..b537f3f4 100644 --- a/docs/models/purchaseorderinput.md +++ b/docs/models/purchaseorderinput.md @@ -9,7 +9,8 @@ | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional purchase order reference. | 123456 | | `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `status` | [OptionalNullable[models.PurchaseOrderStatus]](../models/purchaseorderstatus.md) | :heavy_minus_sign: | N/A | open | | `issued_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date purchase order was issued - YYYY-MM-DD. | 2020-09-30 | | `delivery_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date on which the purchase order is to be delivered - YYYY-MM-DD. | 2020-09-30 | @@ -31,7 +32,7 @@ | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | -| `amortization_type` | [OptionalNullable[models.AmortizationType]](../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `amortization_type` | [OptionalNullable[models.PurchaseOrderAmortizationType]](../models/purchaseorderamortizationtype.md) | :heavy_minus_sign: | Type of amortization | | | `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | | `issued_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of issuance of the purchase order | Email | diff --git a/docs/models/quote.md b/docs/models/quote.md index 33d2e1c9..63cbf753 100644 --- a/docs/models/quote.md +++ b/docs/models/quote.md @@ -11,7 +11,8 @@ | `customer` | [OptionalNullable[models.LinkedCustomer]](../models/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `invoice_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the invoice. | 123456 | | `sales_order_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier for the sales order. | 123456 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `project_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the linked project. | 12345 | | `quote_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date quote was issued - YYYY-MM-DD. | 2020-09-30 | | `expiry_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date until which the quote is valid - YYYY-MM-DD. | 2020-10-30 | diff --git a/docs/models/quoteinput.md b/docs/models/quoteinput.md index 784d580a..6c72f3aa 100644 --- a/docs/models/quoteinput.md +++ b/docs/models/quoteinput.md @@ -8,7 +8,8 @@ | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Quote number. | QT00546 | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `sales_order_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier for the sales order. | 123456 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `project_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the linked project. | 12345 | | `quote_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date quote was issued - YYYY-MM-DD. | 2020-09-30 | | `expiry_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date until which the quote is valid - YYYY-MM-DD. | 2020-10-30 | diff --git a/docs/models/supplier.md b/docs/models/supplier.md index ccc12531..5fa22edf 100644 --- a/docs/models/supplier.md +++ b/docs/models/supplier.md @@ -10,7 +10,7 @@ | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `supplier_category` | *OptionalNullable[str]* | :heavy_minus_sign: | The category/type of the supplier | Insurance | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | diff --git a/docs/models/supplierinput.md b/docs/models/supplierinput.md index e6a5ad45..622a8115 100644 --- a/docs/models/supplierinput.md +++ b/docs/models/supplierinput.md @@ -8,7 +8,7 @@ | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `supplier_category` | *OptionalNullable[str]* | :heavy_minus_sign: | The category/type of the supplier | Insurance | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | diff --git a/docs/sdks/applicants/README.md b/docs/sdks/applicants/README.md index dde6447a..b938dbe2 100644 --- a/docs/sdks/applicants/README.md +++ b/docs/sdks/applicants/README.md @@ -92,7 +92,7 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), ) as apideck: - res = apideck.ats.applicants.create(raw=False, service_id="salesforce", name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=date.fromisoformat("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 ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ + res = apideck.ats.applicants.create(raw=False, service_id="salesforce", name="Elon Musk", salutation="Mr", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=date.fromisoformat("2000-08-12"), gender=apideck_unify.ApplicantGender.MALE, social_security_number="123456789", type_="Candidate", 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=[ { "id": "123", "email": "elon@musk.com", @@ -283,11 +283,15 @@ with Apideck( | `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 | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | +| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | | `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM | | `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 | +| `gender` | [OptionalNullable[models.ApplicantGender]](../../models/applicantgender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male | +| `social_security_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. | 123456789 | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | Candidate | | `cover_letter` | *Optional[str]* | :heavy_minus_sign: | N/A | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk | | `headline` | *Optional[str]* | :heavy_minus_sign: | Typically a list of previous companies where the contact has worked or schools that the contact has attended | PepsiCo, Inc, Central Perk | @@ -404,7 +408,7 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), ) as apideck: - res = apideck.ats.applicants.update(id="", service_id="salesforce", raw=False, name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=date.fromisoformat("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 ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ + res = apideck.ats.applicants.update(id="", service_id="salesforce", raw=False, name="Elon Musk", salutation="Mr", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=date.fromisoformat("2000-08-12"), gender=apideck_unify.ApplicantGender.MALE, social_security_number="123456789", type_="Candidate", 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=[ { "id": "123", "email": "elon@musk.com", @@ -654,11 +658,15 @@ with Apideck( | `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 | | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | +| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | | `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM | | `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 | +| `gender` | [OptionalNullable[models.ApplicantGender]](../../models/applicantgender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male | +| `social_security_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. | 123456789 | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | Candidate | | `cover_letter` | *Optional[str]* | :heavy_minus_sign: | N/A | 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` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk | | `headline` | *Optional[str]* | :heavy_minus_sign: | Typically a list of previous companies where the contact has worked or schools that the contact has attended | PepsiCo, Inc, Central Perk | diff --git a/docs/sdks/billpayments/README.md b/docs/sdks/billpayments/README.md index f4bdc3d1..7d86031e 100644 --- a/docs/sdks/billpayments/README.md +++ b/docs/sdks/billpayments/README.md @@ -302,7 +302,7 @@ with Apideck( | `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 | | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.BillPaymentType]](../../models/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable | @@ -531,7 +531,7 @@ with Apideck( | `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 | | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.BillPaymentType]](../../models/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable | diff --git a/docs/sdks/bills/README.md b/docs/sdks/bills/README.md index a4f9bbdb..ee959f18 100644 --- a/docs/sdks/bills/README.md +++ b/docs/sdks/bills/README.md @@ -98,7 +98,7 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), ) as apideck: - res = apideck.accounting.bills.create(raw=False, service_id="salesforce", bill_number="10001", supplier={ + res = apideck.accounting.bills.create(raw=False, service_id="salesforce", display_id="123456", bill_number="10001", supplier={ "id": "12345", "display_name": "Windsurf Shop", "address": { @@ -127,7 +127,7 @@ with Apideck( "notes": "Address notes or delivery instructions.", "row_version": "1-12345", }, - }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, bill_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-10-30"), paid_date=date.fromisoformat("2020-10-30"), po_number="90000117", reference="123456", line_items=[ + }, company_id="12345", department_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, bill_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-10-30"), paid_date=date.fromisoformat("2020-10-30"), po_number="90000117", reference="123456", line_items=[ { "row_id": "12345", "code": "120-C", @@ -181,7 +181,7 @@ with Apideck( "branch_identifier": "001", "bank_code": "BNH", "currency": apideck_unify.Currency.USD, - }, discount_percentage=5.5, source_document_url="https://www.invoicesolution.com/bill/123456", tracking_categories=[ + }, discount_percentage=5.5, template_id="123456", approved_by="John Doe", tax_method="Due to supplier", document_received=True, source_document_url="https://www.invoicesolution.com/bill/123456", tracking_categories=[ { "id": "123456", "name": "New York", @@ -264,7 +264,16 @@ with Apideck( }, ], }, - ], accounting_period="01-24") + ], accounting_period="01-24", attachments=[ + { + "name": "sample.jpg", + "mime_type": "image/jpeg", + "is_compressed": False, + "encoding": "base64", + "content": "data:image/jpeg;base64,...", + "notes": "A sample image", + }, + ]) assert res.create_bill_response is not None @@ -281,9 +290,11 @@ with Apideck( | `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 | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | @@ -309,12 +320,18 @@ with Apideck( | `accounting_by_row` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. | false | | `bank_account` | [Optional[models.BankAccount]](../../models/bankaccount.md) | :heavy_minus_sign: | N/A | | | `discount_percentage` | *OptionalNullable[float]* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 | +| `template_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional bill template | 123456 | +| `approved_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who approved the bill | John Doe | +| `amortization_type` | [OptionalNullable[models.AmortizationType]](../../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | +| `document_received` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the document has been received | true | | `source_document_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. | https://www.invoicesolution.com/bill/123456 | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `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 | | `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | 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. | | | `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 | +| `attachments` | List[[Nullable[models.LinkedAttachment]](../../models/linkedattachment.md)] | :heavy_minus_sign: | N/A | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -406,7 +423,7 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), ) as apideck: - res = apideck.accounting.bills.update(id="", service_id="salesforce", raw=False, bill_number="10001", supplier={ + res = apideck.accounting.bills.update(id="", service_id="salesforce", raw=False, display_id="123456", bill_number="10001", supplier={ "id": "12345", "display_name": "Windsurf Shop", "address": { @@ -435,7 +452,7 @@ with Apideck( "notes": "Address notes or delivery instructions.", "row_version": "1-12345", }, - }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, bill_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-10-30"), paid_date=date.fromisoformat("2020-10-30"), po_number="90000117", reference="123456", line_items=[ + }, company_id="12345", department_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, bill_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-10-30"), paid_date=date.fromisoformat("2020-10-30"), po_number="90000117", reference="123456", line_items=[ { "row_id": "12345", "code": "120-C", @@ -493,7 +510,7 @@ with Apideck( "branch_identifier": "001", "bank_code": "BNH", "currency": apideck_unify.Currency.USD, - }, discount_percentage=5.5, source_document_url="https://www.invoicesolution.com/bill/123456", tracking_categories=[ + }, discount_percentage=5.5, template_id="123456", approved_by="John Doe", tax_method="Due to supplier", document_received=True, source_document_url="https://www.invoicesolution.com/bill/123456", tracking_categories=[ { "id": "123456", "name": "New York", @@ -593,7 +610,16 @@ with Apideck( }, ], }, - ], accounting_period="01-24") + ], accounting_period="01-24", attachments=[ + { + "name": "sample.jpg", + "mime_type": "image/jpeg", + "is_compressed": False, + "encoding": "base64", + "content": "data:image/jpeg;base64,...", + "notes": "A sample image", + }, + ]) assert res.update_bill_response is not None @@ -611,9 +637,11 @@ with Apideck( | `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 | | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | @@ -639,12 +667,18 @@ with Apideck( | `accounting_by_row` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. | false | | `bank_account` | [Optional[models.BankAccount]](../../models/bankaccount.md) | :heavy_minus_sign: | N/A | | | `discount_percentage` | *OptionalNullable[float]* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 | +| `template_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional bill template | 123456 | +| `approved_by` | *OptionalNullable[str]* | :heavy_minus_sign: | The user who approved the bill | John Doe | +| `amortization_type` | [OptionalNullable[models.AmortizationType]](../../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | +| `document_received` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the document has been received | true | | `source_document_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. | https://www.invoicesolution.com/bill/123456 | | `tracking_categories` | List[[Nullable[models.LinkedTrackingCategory]](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | | | `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 | | `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | 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. | | | `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 | +| `attachments` | List[[Nullable[models.LinkedAttachment]](../../models/linkedattachment.md)] | :heavy_minus_sign: | N/A | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md index 8cfaff15..4a400d01 100644 --- a/docs/sdks/creditnotes/README.md +++ b/docs/sdks/creditnotes/README.md @@ -102,7 +102,7 @@ with Apideck( "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", - }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", balance=27500, remaining_credit=27500, status=apideck_unify.CreditNoteStatus.AUTHORISED, reference="123456", date_issued=parse_datetime("2021-05-01T12:00:00.000Z"), date_paid=parse_datetime("2021-05-01T12:00:00.000Z"), type_=apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT, account={ + }, company_id="12345", department_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", balance=27500, remaining_credit=27500, status=apideck_unify.CreditNoteStatus.AUTHORISED, reference="123456", date_issued=parse_datetime("2021-05-01T12:00:00.000Z"), date_paid=parse_datetime("2021-05-01T12:00:00.000Z"), type_=apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT, account={ "id": "123456", "nominal_code": "N091", "code": "453", @@ -362,7 +362,8 @@ with Apideck( | `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 | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | @@ -482,7 +483,7 @@ with Apideck( "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", - }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", balance=27500, remaining_credit=27500, status=apideck_unify.CreditNoteStatus.AUTHORISED, reference="123456", date_issued=parse_datetime("2021-05-01T12:00:00.000Z"), date_paid=parse_datetime("2021-05-01T12:00:00.000Z"), type_=apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT, account={ + }, company_id="12345", department_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", balance=27500, remaining_credit=27500, status=apideck_unify.CreditNoteStatus.AUTHORISED, reference="123456", date_issued=parse_datetime("2021-05-01T12:00:00.000Z"), date_paid=parse_datetime("2021-05-01T12:00:00.000Z"), type_=apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT, account={ "id": "123456", "nominal_code": "N091", "code": "453", @@ -767,7 +768,8 @@ with Apideck( | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 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 | | `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true | diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md index 0aa3e1f0..b2db6b73 100644 --- a/docs/sdks/customers/README.md +++ b/docs/sdks/customers/README.md @@ -266,7 +266,7 @@ with Apideck( | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | @@ -554,7 +554,7 @@ with Apideck( | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | | `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. | diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md index e8fe7284..62f44993 100644 --- a/docs/sdks/expenses/README.md +++ b/docs/sdks/expenses/README.md @@ -227,7 +227,7 @@ with Apideck( | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `payment_type` | [OptionalNullable[models.ExpensePaymentType]](../../models/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash | | `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 | @@ -491,7 +491,7 @@ with Apideck( | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `payment_type` | [OptionalNullable[models.ExpensePaymentType]](../../models/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash | | `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 | diff --git a/docs/sdks/invoices/README.md b/docs/sdks/invoices/README.md index 0c291294..ce17879c 100644 --- a/docs/sdks/invoices/README.md +++ b/docs/sdks/invoices/README.md @@ -101,11 +101,11 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), ) as apideck: - res = apideck.accounting.invoices.create(raw=False, service_id="salesforce", type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ + res = apideck.accounting.invoices.create(raw=False, service_id="salesforce", display_id="123456", type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", - }, company_id="12345", invoice_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-09-30"), terms="Net 30 days", po_number="90000117", reference="123456", status=apideck_unify.InvoiceStatus.DRAFT, invoice_sent=True, currency=apideck_unify.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=[ + }, company_id="12345", department_id="12345", invoice_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-09-30"), terms="Net 30 days", po_number="90000117", reference="123456", status=apideck_unify.InvoiceStatus.DRAFT, invoice_sent=True, currency=apideck_unify.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", @@ -356,10 +356,12 @@ with Apideck( | `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 | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `type` | [OptionalNullable[models.InvoiceType]](../../models/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Invoice 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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `invoice_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date invoice was issued - YYYY-MM-DD. | 2020-09-30 | | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. | 2020-09-30 | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | @@ -488,11 +490,11 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), ) as apideck: - res = apideck.accounting.invoices.update(id="", service_id="salesforce", raw=False, type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ + res = apideck.accounting.invoices.update(id="", service_id="salesforce", raw=False, display_id="123456", type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", - }, company_id="12345", invoice_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-09-30"), terms="Net 30 days", po_number="90000117", reference="123456", status=apideck_unify.InvoiceStatus.DRAFT, invoice_sent=True, currency=apideck_unify.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=[ + }, company_id="12345", department_id="12345", invoice_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-09-30"), terms="Net 30 days", po_number="90000117", reference="123456", status=apideck_unify.InvoiceStatus.DRAFT, invoice_sent=True, currency=apideck_unify.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", @@ -793,10 +795,12 @@ with Apideck( | `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 | | +| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `type` | [OptionalNullable[models.InvoiceType]](../../models/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Invoice 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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `invoice_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date invoice was issued - YYYY-MM-DD. | 2020-09-30 | | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. | 2020-09-30 | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | diff --git a/docs/sdks/journalentries/README.md b/docs/sdks/journalentries/README.md index 633a8e69..0300449a 100644 --- a/docs/sdks/journalentries/README.md +++ b/docs/sdks/journalentries/README.md @@ -259,7 +259,7 @@ with Apideck( | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `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 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `line_items` | List[[models.JournalEntryLineItemInput](../../models/journalentrylineiteminput.md)] | :heavy_minus_sign: | Requires a minimum of 2 line items that sum to 0 | | | `status` | [OptionalNullable[models.JournalEntryStatus]](../../models/journalentrystatus.md) | :heavy_minus_sign: | Journal entry status | draft | | `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference for the journal entry. | Thank you for your business and have a great day! | @@ -548,7 +548,7 @@ with Apideck( | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `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 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `line_items` | List[[models.JournalEntryLineItemInput](../../models/journalentrylineiteminput.md)] | :heavy_minus_sign: | Requires a minimum of 2 line items that sum to 0 | | | `status` | [OptionalNullable[models.JournalEntryStatus]](../../models/journalentrystatus.md) | :heavy_minus_sign: | Journal entry status | draft | | `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference for the journal entry. | Thank you for your business and have a great day! | diff --git a/docs/sdks/payments/README.md b/docs/sdks/payments/README.md index a911afe2..2df86bba 100644 --- a/docs/sdks/payments/README.md +++ b/docs/sdks/payments/README.md @@ -219,7 +219,7 @@ with Apideck( | `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.PaymentType]](../../models/paymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable | @@ -469,7 +469,7 @@ with Apideck( | `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | | `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 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [Optional[models.PaymentStatus]](../../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [Optional[models.PaymentType]](../../models/paymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable | diff --git a/docs/sdks/purchaseorders/README.md b/docs/sdks/purchaseorders/README.md index c1d243ac..44ba2513 100644 --- a/docs/sdks/purchaseorders/README.md +++ b/docs/sdks/purchaseorders/README.md @@ -127,7 +127,7 @@ with Apideck( "notes": "Address notes or delivery instructions.", "row_version": "1-12345", }, - }, subsidiary_id="12345", company_id="12345", status=apideck_unify.PurchaseOrderStatus.OPEN, issued_date=date.fromisoformat("2020-09-30"), delivery_date=date.fromisoformat("2020-09-30"), expected_arrival_date=date.fromisoformat("2020-09-30"), currency=apideck_unify.Currency.USD, currency_rate=0.69, sub_total=27500, total_tax=2500, total=27500, tax_inclusive=True, line_items=[ + }, subsidiary_id="12345", company_id="12345", department_id="12345", status=apideck_unify.PurchaseOrderStatus.OPEN, issued_date=date.fromisoformat("2020-09-30"), delivery_date=date.fromisoformat("2020-09-30"), expected_arrival_date=date.fromisoformat("2020-09-30"), currency=apideck_unify.Currency.USD, currency_rate=0.69, sub_total=27500, total_tax=2500, total=27500, tax_inclusive=True, line_items=[ { "id": "12345", "row_id": "12345", @@ -360,7 +360,8 @@ with Apideck( | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional purchase order reference. | 123456 | | `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `status` | [OptionalNullable[models.PurchaseOrderStatus]](../../models/purchaseorderstatus.md) | :heavy_minus_sign: | N/A | open | | `issued_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date purchase order was issued - YYYY-MM-DD. | 2020-09-30 | | `delivery_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date on which the purchase order is to be delivered - YYYY-MM-DD. | 2020-09-30 | @@ -382,7 +383,7 @@ with Apideck( | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | -| `amortization_type` | [OptionalNullable[models.AmortizationType]](../../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `amortization_type` | [OptionalNullable[models.PurchaseOrderAmortizationType]](../../models/purchaseorderamortizationtype.md) | :heavy_minus_sign: | Type of amortization | | | `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | | `issued_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of issuance of the purchase order | Email | @@ -513,7 +514,7 @@ with Apideck( "notes": "Address notes or delivery instructions.", "row_version": "1-12345", }, - }, subsidiary_id="12345", company_id="12345", status=apideck_unify.PurchaseOrderStatus.OPEN, issued_date=date.fromisoformat("2020-09-30"), delivery_date=date.fromisoformat("2020-09-30"), expected_arrival_date=date.fromisoformat("2020-09-30"), currency=apideck_unify.Currency.USD, currency_rate=0.69, sub_total=27500, total_tax=2500, total=27500, tax_inclusive=True, line_items=[ + }, subsidiary_id="12345", company_id="12345", department_id="12345", status=apideck_unify.PurchaseOrderStatus.OPEN, issued_date=date.fromisoformat("2020-09-30"), delivery_date=date.fromisoformat("2020-09-30"), expected_arrival_date=date.fromisoformat("2020-09-30"), currency=apideck_unify.Currency.USD, currency_rate=0.69, sub_total=27500, total_tax=2500, total=27500, tax_inclusive=True, line_items=[ { "id": "12345", "row_id": "12345", @@ -727,7 +728,8 @@ with Apideck( | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional purchase order reference. | 123456 | | `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `subsidiary_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `status` | [OptionalNullable[models.PurchaseOrderStatus]](../../models/purchaseorderstatus.md) | :heavy_minus_sign: | N/A | open | | `issued_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date purchase order was issued - YYYY-MM-DD. | 2020-09-30 | | `delivery_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date on which the purchase order is to be delivered - YYYY-MM-DD. | 2020-09-30 | @@ -749,7 +751,7 @@ with Apideck( | `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 | | `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days | -| `amortization_type` | [OptionalNullable[models.AmortizationType]](../../models/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `amortization_type` | [OptionalNullable[models.PurchaseOrderAmortizationType]](../../models/purchaseorderamortizationtype.md) | :heavy_minus_sign: | Type of amortization | | | `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `tax_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | | `issued_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Method of issuance of the purchase order | Email | diff --git a/docs/sdks/quotes/README.md b/docs/sdks/quotes/README.md index 0e1bcb90..caff9319 100644 --- a/docs/sdks/quotes/README.md +++ b/docs/sdks/quotes/README.md @@ -89,7 +89,7 @@ with Apideck( "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", - }, sales_order_id="123456", company_id="12345", project_id="12345", quote_date=date.fromisoformat("2020-09-30"), expiry_date=date.fromisoformat("2020-10-30"), terms="Valid for 30 days", reference="INV-2024-001", status=apideck_unify.QuoteStatus.DRAFT, currency=apideck_unify.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, customer_memo="Thank you for considering our services!", line_items=[ + }, sales_order_id="123456", company_id="12345", department_id="12345", project_id="12345", quote_date=date.fromisoformat("2020-09-30"), expiry_date=date.fromisoformat("2020-10-30"), terms="Valid for 30 days", reference="INV-2024-001", status=apideck_unify.QuoteStatus.DRAFT, currency=apideck_unify.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, customer_memo="Thank you for considering our services!", line_items=[ { "id": "12345", "row_id": "12345", @@ -237,7 +237,8 @@ with Apideck( | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Quote number. | QT00546 | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `sales_order_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier for the sales order. | 123456 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `project_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the linked project. | 12345 | | `quote_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date quote was issued - YYYY-MM-DD. | 2020-09-30 | | `expiry_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date until which the quote is valid - YYYY-MM-DD. | 2020-10-30 | @@ -357,7 +358,7 @@ with Apideck( "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", - }, sales_order_id="123456", company_id="12345", project_id="12345", quote_date=date.fromisoformat("2020-09-30"), expiry_date=date.fromisoformat("2020-10-30"), terms="Valid for 30 days", reference="INV-2024-001", status=apideck_unify.QuoteStatus.DRAFT, currency=apideck_unify.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, customer_memo="Thank you for considering our services!", line_items=[ + }, sales_order_id="123456", company_id="12345", department_id="12345", project_id="12345", quote_date=date.fromisoformat("2020-09-30"), expiry_date=date.fromisoformat("2020-10-30"), terms="Valid for 30 days", reference="INV-2024-001", status=apideck_unify.QuoteStatus.DRAFT, currency=apideck_unify.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, customer_memo="Thank you for considering our services!", line_items=[ { "id": "12345", "row_id": "12345", @@ -499,7 +500,8 @@ with Apideck( | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Quote number. | QT00546 | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `sales_order_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier for the sales order. | 123456 | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the department | 12345 | | `project_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the linked project. | 12345 | | `quote_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date quote was issued - YYYY-MM-DD. | 2020-09-30 | | `expiry_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date until which the quote is valid - YYYY-MM-DD. | 2020-10-30 | diff --git a/docs/sdks/suppliers/README.md b/docs/sdks/suppliers/README.md index 6df014a5..d6e67ea3 100644 --- a/docs/sdks/suppliers/README.md +++ b/docs/sdks/suppliers/README.md @@ -238,7 +238,7 @@ with Apideck( | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `supplier_category` | *OptionalNullable[str]* | :heavy_minus_sign: | The category/type of the supplier | Insurance | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | @@ -514,7 +514,7 @@ with Apideck( | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `supplier_category` | *OptionalNullable[str]* | :heavy_minus_sign: | The category/type of the supplier | Insurance | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | diff --git a/poetry.toml b/poetry.toml index ab1033bd..cd3492ac 100644 --- a/poetry.toml +++ b/poetry.toml @@ -1,2 +1,3 @@ + [virtualenvs] in-project = true diff --git a/pyproject.toml b/pyproject.toml index ca4fef2f..dbd5840f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,7 @@ + [project] name = "apideck-unify" -version = "0.21.1" +version = "0.21.2" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" diff --git a/scripts/publish.sh b/scripts/publish.sh index f2f2cf2c..2a3ead70 100755 --- a/scripts/publish.sh +++ b/scripts/publish.sh @@ -1,5 +1,4 @@ #!/usr/bin/env bash - export POETRY_PYPI_TOKEN_PYPI=${PYPI_TOKEN} poetry run python scripts/prepare_readme.py diff --git a/src/apideck_unify/_version.py b/src/apideck_unify/_version.py index bc18fae0..556f8684 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.21.1" -__openapi_doc_version__: str = "10.20.2" -__gen_version__: str = "2.674.3" -__user_agent__: str = "speakeasy-sdk/python 0.21.1 2.674.3 10.20.2 apideck-unify" +__version__: str = "0.21.2" +__openapi_doc_version__: str = "10.20.6" +__gen_version__: str = "2.681.1" +__user_agent__: str = "speakeasy-sdk/python 0.21.2 2.681.1 10.20.6 apideck-unify" try: if __package__ is not None: diff --git a/src/apideck_unify/applicants.py b/src/apideck_unify/applicants.py index 3a4d7395..c9ac5232 100644 --- a/src/apideck_unify/applicants.py +++ b/src/apideck_unify/applicants.py @@ -386,11 +386,15 @@ def create( app_id: Optional[str] = None, service_id: Optional[str] = None, name: Optional[str] = None, + salutation: OptionalNullable[str] = UNSET, first_name: OptionalNullable[str] = UNSET, last_name: OptionalNullable[str] = UNSET, middle_name: OptionalNullable[str] = UNSET, initials: OptionalNullable[str] = UNSET, birthday: OptionalNullable[date] = UNSET, + gender: OptionalNullable[models.ApplicantGender] = UNSET, + social_security_number: OptionalNullable[str] = UNSET, + type_: Optional[str] = None, cover_letter: Optional[str] = None, photo_url: OptionalNullable[str] = UNSET, headline: Optional[str] = None, @@ -442,11 +446,15 @@ def create( :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: The name of an applicant. + :param salutation: A formal salutation for the person. For example, 'Mr', 'Mrs' :param first_name: The first name of the person. :param last_name: The last name of the person. :param middle_name: Middle name of the person. :param initials: The initials of the person, usually derived from their first, middle, and last names. :param birthday: The date of birth of the person. + :param gender: The gender represents the gender identity of a person. + :param social_security_number: A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + :param type: :param cover_letter: :param photo_url: The URL of the photo of a person. :param headline: Typically a list of previous companies where the contact has worked or schools that the contact has attended @@ -494,11 +502,15 @@ def create( service_id=service_id, applicant=models.ApplicantInput( name=name, + salutation=salutation, first_name=first_name, last_name=last_name, middle_name=middle_name, initials=initials, birthday=birthday, + gender=gender, + social_security_number=social_security_number, + type=type_, cover_letter=cover_letter, photo_url=photo_url, headline=headline, @@ -646,11 +658,15 @@ async def create_async( app_id: Optional[str] = None, service_id: Optional[str] = None, name: Optional[str] = None, + salutation: OptionalNullable[str] = UNSET, first_name: OptionalNullable[str] = UNSET, last_name: OptionalNullable[str] = UNSET, middle_name: OptionalNullable[str] = UNSET, initials: OptionalNullable[str] = UNSET, birthday: OptionalNullable[date] = UNSET, + gender: OptionalNullable[models.ApplicantGender] = UNSET, + social_security_number: OptionalNullable[str] = UNSET, + type_: Optional[str] = None, cover_letter: Optional[str] = None, photo_url: OptionalNullable[str] = UNSET, headline: Optional[str] = None, @@ -702,11 +718,15 @@ async def create_async( :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: The name of an applicant. + :param salutation: A formal salutation for the person. For example, 'Mr', 'Mrs' :param first_name: The first name of the person. :param last_name: The last name of the person. :param middle_name: Middle name of the person. :param initials: The initials of the person, usually derived from their first, middle, and last names. :param birthday: The date of birth of the person. + :param gender: The gender represents the gender identity of a person. + :param social_security_number: A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + :param type: :param cover_letter: :param photo_url: The URL of the photo of a person. :param headline: Typically a list of previous companies where the contact has worked or schools that the contact has attended @@ -754,11 +774,15 @@ async def create_async( service_id=service_id, applicant=models.ApplicantInput( name=name, + salutation=salutation, first_name=first_name, last_name=last_name, middle_name=middle_name, initials=initials, birthday=birthday, + gender=gender, + social_security_number=social_security_number, + type=type_, cover_letter=cover_letter, photo_url=photo_url, headline=headline, @@ -1195,11 +1219,15 @@ def update( service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, + salutation: OptionalNullable[str] = UNSET, first_name: OptionalNullable[str] = UNSET, last_name: OptionalNullable[str] = UNSET, middle_name: OptionalNullable[str] = UNSET, initials: OptionalNullable[str] = UNSET, birthday: OptionalNullable[date] = UNSET, + gender: OptionalNullable[models.ApplicantGender] = UNSET, + social_security_number: OptionalNullable[str] = UNSET, + type_: Optional[str] = None, cover_letter: Optional[str] = None, photo_url: OptionalNullable[str] = UNSET, headline: Optional[str] = None, @@ -1252,11 +1280,15 @@ def update( :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of an applicant. + :param salutation: A formal salutation for the person. For example, 'Mr', 'Mrs' :param first_name: The first name of the person. :param last_name: The last name of the person. :param middle_name: Middle name of the person. :param initials: The initials of the person, usually derived from their first, middle, and last names. :param birthday: The date of birth of the person. + :param gender: The gender represents the gender identity of a person. + :param social_security_number: A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + :param type: :param cover_letter: :param photo_url: The URL of the photo of a person. :param headline: Typically a list of previous companies where the contact has worked or schools that the contact has attended @@ -1305,11 +1337,15 @@ def update( raw=raw, applicant=models.ApplicantInput( name=name, + salutation=salutation, first_name=first_name, last_name=last_name, middle_name=middle_name, initials=initials, birthday=birthday, + gender=gender, + social_security_number=social_security_number, + type=type_, cover_letter=cover_letter, photo_url=photo_url, headline=headline, @@ -1458,11 +1494,15 @@ async def update_async( service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, + salutation: OptionalNullable[str] = UNSET, first_name: OptionalNullable[str] = UNSET, last_name: OptionalNullable[str] = UNSET, middle_name: OptionalNullable[str] = UNSET, initials: OptionalNullable[str] = UNSET, birthday: OptionalNullable[date] = UNSET, + gender: OptionalNullable[models.ApplicantGender] = UNSET, + social_security_number: OptionalNullable[str] = UNSET, + type_: Optional[str] = None, cover_letter: Optional[str] = None, photo_url: OptionalNullable[str] = UNSET, headline: Optional[str] = None, @@ -1515,11 +1555,15 @@ async def update_async( :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of an applicant. + :param salutation: A formal salutation for the person. For example, 'Mr', 'Mrs' :param first_name: The first name of the person. :param last_name: The last name of the person. :param middle_name: Middle name of the person. :param initials: The initials of the person, usually derived from their first, middle, and last names. :param birthday: The date of birth of the person. + :param gender: The gender represents the gender identity of a person. + :param social_security_number: A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + :param type: :param cover_letter: :param photo_url: The URL of the photo of a person. :param headline: Typically a list of previous companies where the contact has worked or schools that the contact has attended @@ -1568,11 +1612,15 @@ async def update_async( raw=raw, applicant=models.ApplicantInput( name=name, + salutation=salutation, first_name=first_name, last_name=last_name, middle_name=middle_name, initials=initials, birthday=birthday, + gender=gender, + social_security_number=social_security_number, + type=type_, cover_letter=cover_letter, photo_url=photo_url, headline=headline, diff --git a/src/apideck_unify/billpayments.py b/src/apideck_unify/billpayments.py index 583b24be..e51aa1e0 100644 --- a/src/apideck_unify/billpayments.py +++ b/src/apideck_unify/billpayments.py @@ -455,7 +455,7 @@ def create( :param payment_method_id: A unique identifier for an object. :param account: :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment @@ -698,7 +698,7 @@ async def create_async( :param payment_method_id: A unique identifier for an object. :param account: :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment @@ -1231,7 +1231,7 @@ def update( :param payment_method_id: A unique identifier for an object. :param account: :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment @@ -1477,7 +1477,7 @@ async def update_async( :param payment_method_id: A unique identifier for an object. :param account: :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment diff --git a/src/apideck_unify/bills.py b/src/apideck_unify/bills.py index 5b591d38..e7ffc112 100644 --- a/src/apideck_unify/bills.py +++ b/src/apideck_unify/bills.py @@ -389,11 +389,13 @@ def create( consumer_id: Optional[str] = None, app_id: Optional[str] = None, service_id: Optional[str] = None, + display_id: OptionalNullable[str] = UNSET, bill_number: OptionalNullable[str] = UNSET, supplier: OptionalNullable[ Union[models.LinkedSupplierInput, models.LinkedSupplierInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -430,6 +432,11 @@ def create( Union[models.BankAccount, models.BankAccountTypedDict] ] = None, discount_percentage: OptionalNullable[float] = UNSET, + template_id: OptionalNullable[str] = UNSET, + approved_by: OptionalNullable[str] = UNSET, + amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + tax_method: OptionalNullable[str] = UNSET, + document_received: OptionalNullable[bool] = UNSET, source_document_url: OptionalNullable[str] = UNSET, tracking_categories: OptionalNullable[ Union[ @@ -445,6 +452,12 @@ def create( Union[List[models.PassThroughBody], List[models.PassThroughBodyTypedDict]] ] = None, accounting_period: OptionalNullable[str] = UNSET, + attachments: Optional[ + Union[ + List[Nullable[models.LinkedAttachment]], + List[Nullable[models.LinkedAttachmentTypedDict]], + ] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -458,9 +471,11 @@ def create( :param consumer_id: ID of the consumer which you want to get or push data from :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. + :param display_id: Id to be displayed. :param bill_number: Reference to supplier bill number :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -486,12 +501,18 @@ def create( :param accounting_by_row: Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. :param bank_account: :param discount_percentage: Discount percentage applied to this transaction. + :param template_id: Optional bill template + :param approved_by: The user who approved the bill + :param amortization_type: Type of amortization + :param tax_method: Method of tax calculation + :param document_received: Whether the document has been received :param source_document_url: URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. :param tracking_categories: A list of linked tracking categories. :param row_version: 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. :param custom_fields: :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. :param accounting_period: Accounting period + :param attachments: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -513,11 +534,13 @@ def create( app_id=app_id, service_id=service_id, bill=models.BillInput( + display_id=display_id, bill_number=bill_number, supplier=utils.get_pydantic_model( supplier, OptionalNullable[models.LinkedSupplierInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, @@ -549,6 +572,11 @@ def create( bank_account, Optional[models.BankAccount] ), discount_percentage=discount_percentage, + template_id=template_id, + approved_by=approved_by, + amortization_type=amortization_type, + tax_method=tax_method, + document_received=document_received, source_document_url=source_document_url, tracking_categories=utils.get_pydantic_model( tracking_categories, @@ -562,6 +590,9 @@ def create( pass_through, Optional[List[models.PassThroughBody]] ), accounting_period=accounting_period, + attachments=utils.get_pydantic_model( + attachments, Optional[List[Nullable[models.LinkedAttachment]]] + ), ), ) @@ -671,11 +702,13 @@ async def create_async( consumer_id: Optional[str] = None, app_id: Optional[str] = None, service_id: Optional[str] = None, + display_id: OptionalNullable[str] = UNSET, bill_number: OptionalNullable[str] = UNSET, supplier: OptionalNullable[ Union[models.LinkedSupplierInput, models.LinkedSupplierInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -712,6 +745,11 @@ async def create_async( Union[models.BankAccount, models.BankAccountTypedDict] ] = None, discount_percentage: OptionalNullable[float] = UNSET, + template_id: OptionalNullable[str] = UNSET, + approved_by: OptionalNullable[str] = UNSET, + amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + tax_method: OptionalNullable[str] = UNSET, + document_received: OptionalNullable[bool] = UNSET, source_document_url: OptionalNullable[str] = UNSET, tracking_categories: OptionalNullable[ Union[ @@ -727,6 +765,12 @@ async def create_async( Union[List[models.PassThroughBody], List[models.PassThroughBodyTypedDict]] ] = None, accounting_period: OptionalNullable[str] = UNSET, + attachments: Optional[ + Union[ + List[Nullable[models.LinkedAttachment]], + List[Nullable[models.LinkedAttachmentTypedDict]], + ] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -740,9 +784,11 @@ async def create_async( :param consumer_id: ID of the consumer which you want to get or push data from :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. + :param display_id: Id to be displayed. :param bill_number: Reference to supplier bill number :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -768,12 +814,18 @@ async def create_async( :param accounting_by_row: Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. :param bank_account: :param discount_percentage: Discount percentage applied to this transaction. + :param template_id: Optional bill template + :param approved_by: The user who approved the bill + :param amortization_type: Type of amortization + :param tax_method: Method of tax calculation + :param document_received: Whether the document has been received :param source_document_url: URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. :param tracking_categories: A list of linked tracking categories. :param row_version: 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. :param custom_fields: :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. :param accounting_period: Accounting period + :param attachments: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -795,11 +847,13 @@ async def create_async( app_id=app_id, service_id=service_id, bill=models.BillInput( + display_id=display_id, bill_number=bill_number, supplier=utils.get_pydantic_model( supplier, OptionalNullable[models.LinkedSupplierInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, @@ -831,6 +885,11 @@ async def create_async( bank_account, Optional[models.BankAccount] ), discount_percentage=discount_percentage, + template_id=template_id, + approved_by=approved_by, + amortization_type=amortization_type, + tax_method=tax_method, + document_received=document_received, source_document_url=source_document_url, tracking_categories=utils.get_pydantic_model( tracking_categories, @@ -844,6 +903,9 @@ async def create_async( pass_through, Optional[List[models.PassThroughBody]] ), accounting_period=accounting_period, + attachments=utils.get_pydantic_model( + attachments, Optional[List[Nullable[models.LinkedAttachment]]] + ), ), ) @@ -1242,11 +1304,13 @@ def update( app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, + display_id: OptionalNullable[str] = UNSET, bill_number: OptionalNullable[str] = UNSET, supplier: OptionalNullable[ Union[models.LinkedSupplierInput, models.LinkedSupplierInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -1283,6 +1347,11 @@ def update( Union[models.BankAccount, models.BankAccountTypedDict] ] = None, discount_percentage: OptionalNullable[float] = UNSET, + template_id: OptionalNullable[str] = UNSET, + approved_by: OptionalNullable[str] = UNSET, + amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + tax_method: OptionalNullable[str] = UNSET, + document_received: OptionalNullable[bool] = UNSET, source_document_url: OptionalNullable[str] = UNSET, tracking_categories: OptionalNullable[ Union[ @@ -1298,6 +1367,12 @@ def update( Union[List[models.PassThroughBody], List[models.PassThroughBodyTypedDict]] ] = None, accounting_period: OptionalNullable[str] = UNSET, + attachments: Optional[ + Union[ + List[Nullable[models.LinkedAttachment]], + List[Nullable[models.LinkedAttachmentTypedDict]], + ] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1312,9 +1387,11 @@ def update( :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes + :param display_id: Id to be displayed. :param bill_number: Reference to supplier bill number :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -1340,12 +1417,18 @@ def update( :param accounting_by_row: Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. :param bank_account: :param discount_percentage: Discount percentage applied to this transaction. + :param template_id: Optional bill template + :param approved_by: The user who approved the bill + :param amortization_type: Type of amortization + :param tax_method: Method of tax calculation + :param document_received: Whether the document has been received :param source_document_url: URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. :param tracking_categories: A list of linked tracking categories. :param row_version: 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. :param custom_fields: :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. :param accounting_period: Accounting period + :param attachments: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1368,11 +1451,13 @@ def update( service_id=service_id, raw=raw, bill=models.BillInput( + display_id=display_id, bill_number=bill_number, supplier=utils.get_pydantic_model( supplier, OptionalNullable[models.LinkedSupplierInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, @@ -1404,6 +1489,11 @@ def update( bank_account, Optional[models.BankAccount] ), discount_percentage=discount_percentage, + template_id=template_id, + approved_by=approved_by, + amortization_type=amortization_type, + tax_method=tax_method, + document_received=document_received, source_document_url=source_document_url, tracking_categories=utils.get_pydantic_model( tracking_categories, @@ -1417,6 +1507,9 @@ def update( pass_through, Optional[List[models.PassThroughBody]] ), accounting_period=accounting_period, + attachments=utils.get_pydantic_model( + attachments, Optional[List[Nullable[models.LinkedAttachment]]] + ), ), ) @@ -1527,11 +1620,13 @@ async def update_async( app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, + display_id: OptionalNullable[str] = UNSET, bill_number: OptionalNullable[str] = UNSET, supplier: OptionalNullable[ Union[models.LinkedSupplierInput, models.LinkedSupplierInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -1568,6 +1663,11 @@ async def update_async( Union[models.BankAccount, models.BankAccountTypedDict] ] = None, discount_percentage: OptionalNullable[float] = UNSET, + template_id: OptionalNullable[str] = UNSET, + approved_by: OptionalNullable[str] = UNSET, + amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + tax_method: OptionalNullable[str] = UNSET, + document_received: OptionalNullable[bool] = UNSET, source_document_url: OptionalNullable[str] = UNSET, tracking_categories: OptionalNullable[ Union[ @@ -1583,6 +1683,12 @@ async def update_async( Union[List[models.PassThroughBody], List[models.PassThroughBodyTypedDict]] ] = None, accounting_period: OptionalNullable[str] = UNSET, + attachments: Optional[ + Union[ + List[Nullable[models.LinkedAttachment]], + List[Nullable[models.LinkedAttachmentTypedDict]], + ] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1597,9 +1703,11 @@ async def update_async( :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes + :param display_id: Id to be displayed. :param bill_number: Reference to supplier bill number :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -1625,12 +1733,18 @@ async def update_async( :param accounting_by_row: Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. :param bank_account: :param discount_percentage: Discount percentage applied to this transaction. + :param template_id: Optional bill template + :param approved_by: The user who approved the bill + :param amortization_type: Type of amortization + :param tax_method: Method of tax calculation + :param document_received: Whether the document has been received :param source_document_url: URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. :param tracking_categories: A list of linked tracking categories. :param row_version: 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. :param custom_fields: :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. :param accounting_period: Accounting period + :param attachments: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1653,11 +1767,13 @@ async def update_async( service_id=service_id, raw=raw, bill=models.BillInput( + display_id=display_id, bill_number=bill_number, supplier=utils.get_pydantic_model( supplier, OptionalNullable[models.LinkedSupplierInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, @@ -1689,6 +1805,11 @@ async def update_async( bank_account, Optional[models.BankAccount] ), discount_percentage=discount_percentage, + template_id=template_id, + approved_by=approved_by, + amortization_type=amortization_type, + tax_method=tax_method, + document_received=document_received, source_document_url=source_document_url, tracking_categories=utils.get_pydantic_model( tracking_categories, @@ -1702,6 +1823,9 @@ async def update_async( pass_through, Optional[List[models.PassThroughBody]] ), accounting_period=accounting_period, + attachments=utils.get_pydantic_model( + attachments, Optional[List[Nullable[models.LinkedAttachment]]] + ), ), ) diff --git a/src/apideck_unify/creditnotes.py b/src/apideck_unify/creditnotes.py index 7da8ac66..f63e35be 100644 --- a/src/apideck_unify/creditnotes.py +++ b/src/apideck_unify/creditnotes.py @@ -403,6 +403,7 @@ def create( Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -468,7 +469,8 @@ def create( :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param number: Credit note number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -519,6 +521,7 @@ def create( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, @@ -676,6 +679,7 @@ async def create_async( Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -741,7 +745,8 @@ async def create_async( :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param number: Credit note number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -792,6 +797,7 @@ async def create_async( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, @@ -1238,6 +1244,7 @@ def update( Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -1304,7 +1311,8 @@ def update( :param raw: Include raw response. Mostly used for debugging purposes :param number: Credit note number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -1356,6 +1364,7 @@ def update( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, @@ -1514,6 +1523,7 @@ async def update_async( Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, tax_inclusive: OptionalNullable[bool] = UNSET, @@ -1580,7 +1590,8 @@ async def update_async( :param raw: Include raw response. Mostly used for debugging purposes :param number: Credit note number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param tax_inclusive: Amounts are including tax @@ -1632,6 +1643,7 @@ async def update_async( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, currency=currency, currency_rate=currency_rate, tax_inclusive=tax_inclusive, diff --git a/src/apideck_unify/customers.py b/src/apideck_unify/customers.py index 4a3fc69f..5abe3696 100644 --- a/src/apideck_unify/customers.py +++ b/src/apideck_unify/customers.py @@ -457,7 +457,7 @@ def create( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param title: The job title of the person. :param first_name: The first name of the person. :param middle_name: Middle name of the person. @@ -723,7 +723,7 @@ async def create_async( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param title: The job title of the person. :param first_name: The first name of the person. :param middle_name: Middle name of the person. @@ -1279,7 +1279,7 @@ def update( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param title: The job title of the person. :param first_name: The first name of the person. :param middle_name: Middle name of the person. @@ -1548,7 +1548,7 @@ async def update_async( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param title: The job title of the person. :param first_name: The first name of the person. :param middle_name: Middle name of the person. diff --git a/src/apideck_unify/expenses.py b/src/apideck_unify/expenses.py index 92842b1f..cf61e3e5 100644 --- a/src/apideck_unify/expenses.py +++ b/src/apideck_unify/expenses.py @@ -401,7 +401,7 @@ def create( :param number: Number. :param customer_id: The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. :param supplier_id: The ID of the supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param department_id: The ID of the department :param payment_type: The type of payment for the expense. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). @@ -621,7 +621,7 @@ async def create_async( :param number: Number. :param customer_id: The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. :param supplier_id: The ID of the supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param department_id: The ID of the department :param payment_type: The type of payment for the expense. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). @@ -1125,7 +1125,7 @@ def update( :param number: Number. :param customer_id: The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. :param supplier_id: The ID of the supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param department_id: The ID of the department :param payment_type: The type of payment for the expense. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). @@ -1348,7 +1348,7 @@ async def update_async( :param number: Number. :param customer_id: The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. :param supplier_id: The ID of the supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param department_id: The ID of the department :param payment_type: The type of payment for the expense. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). diff --git a/src/apideck_unify/invoices.py b/src/apideck_unify/invoices.py index b0d0f70b..56a5bba9 100644 --- a/src/apideck_unify/invoices.py +++ b/src/apideck_unify/invoices.py @@ -389,12 +389,14 @@ def create( consumer_id: Optional[str] = None, app_id: Optional[str] = None, service_id: Optional[str] = None, + display_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[models.InvoiceType] = UNSET, number: OptionalNullable[str] = UNSET, customer: OptionalNullable[ Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, invoice_date: OptionalNullable[date] = UNSET, due_date: OptionalNullable[date] = UNSET, terms: OptionalNullable[str] = UNSET, @@ -479,10 +481,12 @@ def create( :param consumer_id: ID of the consumer which you want to get or push data from :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. + :param display_id: Id to be displayed. :param type: Invoice type :param number: Invoice number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param invoice_date: Date invoice was issued - YYYY-MM-DD. :param due_date: The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. :param terms: Terms of payment. @@ -540,12 +544,14 @@ def create( app_id=app_id, service_id=service_id, invoice=models.InvoiceInput( + display_id=display_id, type=type_, number=number, customer=utils.get_pydantic_model( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, invoice_date=invoice_date, due_date=due_date, terms=terms, @@ -714,12 +720,14 @@ async def create_async( consumer_id: Optional[str] = None, app_id: Optional[str] = None, service_id: Optional[str] = None, + display_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[models.InvoiceType] = UNSET, number: OptionalNullable[str] = UNSET, customer: OptionalNullable[ Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, invoice_date: OptionalNullable[date] = UNSET, due_date: OptionalNullable[date] = UNSET, terms: OptionalNullable[str] = UNSET, @@ -804,10 +812,12 @@ async def create_async( :param consumer_id: ID of the consumer which you want to get or push data from :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. + :param display_id: Id to be displayed. :param type: Invoice type :param number: Invoice number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param invoice_date: Date invoice was issued - YYYY-MM-DD. :param due_date: The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. :param terms: Terms of payment. @@ -865,12 +875,14 @@ async def create_async( app_id=app_id, service_id=service_id, invoice=models.InvoiceInput( + display_id=display_id, type=type_, number=number, customer=utils.get_pydantic_model( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, invoice_date=invoice_date, due_date=due_date, terms=terms, @@ -1328,12 +1340,14 @@ def update( app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, + display_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[models.InvoiceType] = UNSET, number: OptionalNullable[str] = UNSET, customer: OptionalNullable[ Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, invoice_date: OptionalNullable[date] = UNSET, due_date: OptionalNullable[date] = UNSET, terms: OptionalNullable[str] = UNSET, @@ -1419,10 +1433,12 @@ def update( :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes + :param display_id: Id to be displayed. :param type: Invoice type :param number: Invoice number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param invoice_date: Date invoice was issued - YYYY-MM-DD. :param due_date: The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. :param terms: Terms of payment. @@ -1481,12 +1497,14 @@ def update( service_id=service_id, raw=raw, invoice=models.InvoiceInput( + display_id=display_id, type=type_, number=number, customer=utils.get_pydantic_model( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, invoice_date=invoice_date, due_date=due_date, terms=terms, @@ -1656,12 +1674,14 @@ async def update_async( app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, + display_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[models.InvoiceType] = UNSET, number: OptionalNullable[str] = UNSET, customer: OptionalNullable[ Union[models.LinkedCustomerInput, models.LinkedCustomerInputTypedDict] ] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, invoice_date: OptionalNullable[date] = UNSET, due_date: OptionalNullable[date] = UNSET, terms: OptionalNullable[str] = UNSET, @@ -1747,10 +1767,12 @@ async def update_async( :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes + :param display_id: Id to be displayed. :param type: Invoice type :param number: Invoice number. :param customer: The customer this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param invoice_date: Date invoice was issued - YYYY-MM-DD. :param due_date: The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. :param terms: Terms of payment. @@ -1809,12 +1831,14 @@ async def update_async( service_id=service_id, raw=raw, invoice=models.InvoiceInput( + display_id=display_id, type=type_, number=number, customer=utils.get_pydantic_model( customer, OptionalNullable[models.LinkedCustomerInput] ), company_id=company_id, + department_id=department_id, invoice_date=invoice_date, due_date=due_date, terms=terms, diff --git a/src/apideck_unify/journalentries.py b/src/apideck_unify/journalentries.py index f0ef089d..41317085 100644 --- a/src/apideck_unify/journalentries.py +++ b/src/apideck_unify/journalentries.py @@ -444,7 +444,7 @@ def create( :param title: Journal entry title :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param line_items: Requires a minimum of 2 line items that sum to 0 :param status: Journal entry status :param memo: Reference for the journal entry. @@ -661,7 +661,7 @@ async def create_async( :param title: Journal entry title :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param line_items: Requires a minimum of 2 line items that sum to 0 :param status: Journal entry status :param memo: Reference for the journal entry. @@ -1168,7 +1168,7 @@ def update( :param title: Journal entry title :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param line_items: Requires a minimum of 2 line items that sum to 0 :param status: Journal entry status :param memo: Reference for the journal entry. @@ -1388,7 +1388,7 @@ async def update_async( :param title: Journal entry title :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param line_items: Requires a minimum of 2 line items that sum to 0 :param status: Journal entry status :param memo: Reference for the journal entry. diff --git a/src/apideck_unify/models/__init__.py b/src/apideck_unify/models/__init__.py index 85ae03b0..8cf34ca9 100644 --- a/src/apideck_unify/models/__init__.py +++ b/src/apideck_unify/models/__init__.py @@ -977,6 +977,7 @@ from .apistatus import APIStatus from .applicant import ( Applicant, + ApplicantGender, ApplicantInput, ApplicantInputTypedDict, ApplicantType, @@ -1153,7 +1154,14 @@ TransactionsTypedDict, ) from .benefit import Benefit, BenefitTypedDict - from .bill import Bill, BillInput, BillInputTypedDict, BillStatus, BillTypedDict + from .bill import ( + AmortizationType, + Bill, + BillInput, + BillInputTypedDict, + BillStatus, + BillTypedDict, + ) from .billlineitem import ( BillLineItem, BillLineItemInput, @@ -3273,7 +3281,6 @@ InvoiceItemsSortTypedDict, ) from .invoicelineitem import ( - Budget, InvoiceLineItem, InvoiceLineItemInput, InvoiceLineItemInputTypedDict, @@ -3474,6 +3481,7 @@ LedgerAccountsSortBy, LedgerAccountsSortTypedDict, ) + from .linkedattachment import LinkedAttachment, LinkedAttachmentTypedDict from .linkedconnectorresource import ( LinkedConnectorResource, LinkedConnectorResourceTypedDict, @@ -3508,6 +3516,7 @@ LinkedTrackingCategory, LinkedTrackingCategoryTypedDict, ) + from .linkedworktag import LinkedWorktag, LinkedWorktagTypedDict from .links import Links, LinksTypedDict from .log import ( Log, @@ -3623,8 +3632,8 @@ ) from .profitandlosstype import ProfitAndLossType from .purchaseorder import ( - AmortizationType, PurchaseOrder, + PurchaseOrderAmortizationType, PurchaseOrderInput, PurchaseOrderInputTypedDict, PurchaseOrderStatus, @@ -5013,6 +5022,7 @@ "ApisFilter", "ApisFilterTypedDict", "Applicant", + "ApplicantGender", "ApplicantInput", "ApplicantInputTypedDict", "ApplicantType", @@ -5171,7 +5181,6 @@ "BlocksTypedDict", "Branch", "BranchTypedDict", - "Budget", "By", "CategoriesFilter", "CategoriesFilterType", @@ -6876,6 +6885,8 @@ "LedgerAccountsSort", "LedgerAccountsSortBy", "LedgerAccountsSortTypedDict", + "LinkedAttachment", + "LinkedAttachmentTypedDict", "LinkedConnectorResource", "LinkedConnectorResourceTypedDict", "LinkedCustomer", @@ -6910,6 +6921,8 @@ "LinkedTaxRateTypedDict", "LinkedTrackingCategory", "LinkedTrackingCategoryTypedDict", + "LinkedWorktag", + "LinkedWorktagTypedDict", "Links", "LinksTypedDict", "LocationStatus", @@ -7036,6 +7049,7 @@ "PurchaseDetails", "PurchaseDetailsTypedDict", "PurchaseOrder", + "PurchaseOrderAmortizationType", "PurchaseOrderInput", "PurchaseOrderInputTypedDict", "PurchaseOrderStatus", @@ -8285,6 +8299,7 @@ "ApisFilterTypedDict": ".apisfilter", "APIStatus": ".apistatus", "Applicant": ".applicant", + "ApplicantGender": ".applicant", "ApplicantInput": ".applicant", "ApplicantInputTypedDict": ".applicant", "ApplicantType": ".applicant", @@ -8429,6 +8444,7 @@ "TransactionsTypedDict": ".bankfeedstatement", "Benefit": ".benefit", "BenefitTypedDict": ".benefit", + "AmortizationType": ".bill", "Bill": ".bill", "BillInput": ".bill", "BillInputTypedDict": ".bill", @@ -10011,7 +10027,6 @@ "InvoiceItemsSort": ".invoiceitemssort", "InvoiceItemsSortBy": ".invoiceitemssort", "InvoiceItemsSortTypedDict": ".invoiceitemssort", - "Budget": ".invoicelineitem", "InvoiceLineItem": ".invoicelineitem", "InvoiceLineItemInput": ".invoicelineitem", "InvoiceLineItemInputTypedDict": ".invoicelineitem", @@ -10175,6 +10190,8 @@ "LedgerAccountsSort": ".ledgeraccountssort", "LedgerAccountsSortBy": ".ledgeraccountssort", "LedgerAccountsSortTypedDict": ".ledgeraccountssort", + "LinkedAttachment": ".linkedattachment", + "LinkedAttachmentTypedDict": ".linkedattachment", "LinkedConnectorResource": ".linkedconnectorresource", "LinkedConnectorResourceTypedDict": ".linkedconnectorresource", "LinkedCustomer": ".linkedcustomer", @@ -10207,6 +10224,8 @@ "LinkedTaxRateInputTypedDict": ".linkedtaxrate_input", "LinkedTrackingCategory": ".linkedtrackingcategory", "LinkedTrackingCategoryTypedDict": ".linkedtrackingcategory", + "LinkedWorktag": ".linkedworktag", + "LinkedWorktagTypedDict": ".linkedworktag", "Links": ".links", "LinksTypedDict": ".links", "Log": ".log", @@ -10324,8 +10343,8 @@ "ProfitAndLossIndicator": ".profitandlossindicator", "ProfitAndLossIndicatorTypedDict": ".profitandlossindicator", "ProfitAndLossType": ".profitandlosstype", - "AmortizationType": ".purchaseorder", "PurchaseOrder": ".purchaseorder", + "PurchaseOrderAmortizationType": ".purchaseorder", "PurchaseOrderInput": ".purchaseorder", "PurchaseOrderInputTypedDict": ".purchaseorder", "PurchaseOrderStatus": ".purchaseorder", diff --git a/src/apideck_unify/models/applicant.py b/src/apideck_unify/models/applicant.py index fb13b142..834158af 100644 --- a/src/apideck_unify/models/applicant.py +++ b/src/apideck_unify/models/applicant.py @@ -21,6 +21,16 @@ from typing_extensions import Annotated, NotRequired, TypedDict +class ApplicantGender(str, Enum): + r"""The gender represents the gender identity of a person.""" + + MALE = "male" + FEMALE = "female" + UNISEX = "unisex" + OTHER = "other" + NOT_SPECIFIED = "not_specified" + + class ApplicantType(str, Enum): r"""The type of website""" @@ -136,6 +146,8 @@ class ApplicantTypedDict(TypedDict): r"""A unique identifier for an object.""" name: NotRequired[str] r"""The name of an applicant.""" + salutation: NotRequired[Nullable[str]] + r"""A formal salutation for the person. For example, 'Mr', 'Mrs'""" first_name: NotRequired[Nullable[str]] r"""The first name of the person.""" last_name: NotRequired[Nullable[str]] @@ -146,6 +158,11 @@ class ApplicantTypedDict(TypedDict): r"""The initials of the person, usually derived from their first, middle, and last names.""" birthday: NotRequired[Nullable[date]] r"""The date of birth of the person.""" + gender: NotRequired[Nullable[ApplicantGender]] + r"""The gender represents the gender identity of a person.""" + social_security_number: NotRequired[Nullable[str]] + r"""A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.""" + type: NotRequired[str] cover_letter: NotRequired[str] job_url: NotRequired[Nullable[str]] photo_url: NotRequired[Nullable[str]] @@ -206,6 +223,9 @@ class Applicant(BaseModel): name: Optional[str] = None r"""The name of an applicant.""" + salutation: OptionalNullable[str] = UNSET + r"""A formal salutation for the person. For example, 'Mr', 'Mrs'""" + first_name: OptionalNullable[str] = UNSET r"""The first name of the person.""" @@ -221,6 +241,14 @@ class Applicant(BaseModel): birthday: OptionalNullable[date] = UNSET r"""The date of birth of the person.""" + gender: OptionalNullable[ApplicantGender] = UNSET + r"""The gender represents the gender identity of a person.""" + + social_security_number: OptionalNullable[str] = UNSET + r"""A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.""" + + type: Optional[str] = None + cover_letter: Optional[str] = None job_url: OptionalNullable[str] = UNSET @@ -320,11 +348,15 @@ def serialize_model(self, handler): optional_fields = [ "id", "name", + "salutation", "first_name", "last_name", "middle_name", "initials", "birthday", + "gender", + "social_security_number", + "type", "cover_letter", "job_url", "photo_url", @@ -365,11 +397,14 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ + "salutation", "first_name", "last_name", "middle_name", "initials", "birthday", + "gender", + "social_security_number", "job_url", "photo_url", "title", @@ -423,6 +458,8 @@ def serialize_model(self, handler): class ApplicantInputTypedDict(TypedDict): name: NotRequired[str] r"""The name of an applicant.""" + salutation: NotRequired[Nullable[str]] + r"""A formal salutation for the person. For example, 'Mr', 'Mrs'""" first_name: NotRequired[Nullable[str]] r"""The first name of the person.""" last_name: NotRequired[Nullable[str]] @@ -433,6 +470,11 @@ class ApplicantInputTypedDict(TypedDict): r"""The initials of the person, usually derived from their first, middle, and last names.""" birthday: NotRequired[Nullable[date]] r"""The date of birth of the person.""" + gender: NotRequired[Nullable[ApplicantGender]] + r"""The gender represents the gender identity of a person.""" + social_security_number: NotRequired[Nullable[str]] + r"""A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.""" + type: NotRequired[str] cover_letter: NotRequired[str] photo_url: NotRequired[Nullable[str]] r"""The URL of the photo of a person.""" @@ -470,6 +512,9 @@ class ApplicantInput(BaseModel): name: Optional[str] = None r"""The name of an applicant.""" + salutation: OptionalNullable[str] = UNSET + r"""A formal salutation for the person. For example, 'Mr', 'Mrs'""" + first_name: OptionalNullable[str] = UNSET r"""The first name of the person.""" @@ -485,6 +530,14 @@ class ApplicantInput(BaseModel): birthday: OptionalNullable[date] = UNSET r"""The date of birth of the person.""" + gender: OptionalNullable[ApplicantGender] = UNSET + r"""The gender represents the gender identity of a person.""" + + social_security_number: OptionalNullable[str] = UNSET + r"""A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.""" + + type: Optional[str] = None + cover_letter: Optional[str] = None photo_url: OptionalNullable[str] = UNSET @@ -550,11 +603,15 @@ class ApplicantInput(BaseModel): def serialize_model(self, handler): optional_fields = [ "name", + "salutation", "first_name", "last_name", "middle_name", "initials", "birthday", + "gender", + "social_security_number", + "type", "cover_letter", "photo_url", "headline", @@ -582,11 +639,14 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ + "salutation", "first_name", "last_name", "middle_name", "initials", "birthday", + "gender", + "social_security_number", "photo_url", "title", "application_ids", diff --git a/src/apideck_unify/models/bill.py b/src/apideck_unify/models/bill.py index c355755e..14519b75 100644 --- a/src/apideck_unify/models/bill.py +++ b/src/apideck_unify/models/bill.py @@ -10,6 +10,7 @@ ) from .currency import Currency from .customfield import CustomField, CustomFieldTypedDict +from .linkedattachment import LinkedAttachment, LinkedAttachmentTypedDict from .linkedledgeraccount import LinkedLedgerAccount, LinkedLedgerAccountTypedDict from .linkedledgeraccount_input import ( LinkedLedgerAccountInput, @@ -49,17 +50,30 @@ class BillStatus(str, Enum): DELETED = "deleted" +class AmortizationType(str, Enum): + r"""Type of amortization""" + + MANUAL = "manual" + RECEIPT = "receipt" + SCHEDULE = "schedule" + OTHER = "other" + + 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""" + display_id: NotRequired[Nullable[str]] + r"""Id to be displayed.""" bill_number: NotRequired[Nullable[str]] r"""Reference to supplier bill number""" 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""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" currency: NotRequired[Nullable[Currency]] r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" currency_rate: NotRequired[Nullable[float]] @@ -106,6 +120,16 @@ class BillTypedDict(TypedDict): bank_account: NotRequired[BankAccountTypedDict] discount_percentage: NotRequired[Nullable[float]] r"""Discount percentage applied to this transaction.""" + template_id: NotRequired[Nullable[str]] + r"""Optional bill template""" + approved_by: NotRequired[Nullable[str]] + r"""The user who approved the bill""" + amortization_type: NotRequired[Nullable[AmortizationType]] + r"""Type of amortization""" + tax_method: NotRequired[Nullable[str]] + r"""Method of tax calculation""" + document_received: NotRequired[Nullable[bool]] + r"""Whether the document has been received""" source_document_url: NotRequired[Nullable[str]] r"""URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.""" tracking_categories: NotRequired[ @@ -129,6 +153,7 @@ class BillTypedDict(TypedDict): 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""" + attachments: NotRequired[List[Nullable[LinkedAttachmentTypedDict]]] class Bill(BaseModel): @@ -138,6 +163,9 @@ class Bill(BaseModel): downstream_id: OptionalNullable[str] = UNSET r"""The third-party API ID of original entity""" + display_id: OptionalNullable[str] = UNSET + r"""Id to be displayed.""" + bill_number: OptionalNullable[str] = UNSET r"""Reference to supplier bill number""" @@ -145,7 +173,10 @@ class Bill(BaseModel): r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" currency: OptionalNullable[Currency] = UNSET r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" @@ -218,6 +249,21 @@ class Bill(BaseModel): discount_percentage: OptionalNullable[float] = UNSET r"""Discount percentage applied to this transaction.""" + template_id: OptionalNullable[str] = UNSET + r"""Optional bill template""" + + approved_by: OptionalNullable[str] = UNSET + r"""The user who approved the bill""" + + amortization_type: OptionalNullable[AmortizationType] = UNSET + r"""Type of amortization""" + + tax_method: OptionalNullable[str] = UNSET + r"""Method of tax calculation""" + + document_received: OptionalNullable[bool] = UNSET + r"""Whether the document has been received""" + source_document_url: OptionalNullable[str] = UNSET r"""URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.""" @@ -252,14 +298,18 @@ class Bill(BaseModel): accounting_period: OptionalNullable[str] = UNSET r"""Accounting period""" + attachments: Optional[List[Nullable[LinkedAttachment]]] = None + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ "id", "downstream_id", + "display_id", "bill_number", "supplier", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", @@ -285,6 +335,11 @@ def serialize_model(self, handler): "accounting_by_row", "bank_account", "discount_percentage", + "template_id", + "approved_by", + "amortization_type", + "tax_method", + "document_received", "source_document_url", "tracking_categories", "updated_by", @@ -296,12 +351,15 @@ def serialize_model(self, handler): "custom_mappings", "pass_through", "accounting_period", + "attachments", ] nullable_fields = [ "downstream_id", + "display_id", "bill_number", "supplier", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", @@ -325,6 +383,11 @@ def serialize_model(self, handler): "language", "accounting_by_row", "discount_percentage", + "template_id", + "approved_by", + "amortization_type", + "tax_method", + "document_received", "source_document_url", "tracking_categories", "updated_by", @@ -363,12 +426,16 @@ def serialize_model(self, handler): class BillInputTypedDict(TypedDict): + display_id: NotRequired[Nullable[str]] + r"""Id to be displayed.""" bill_number: NotRequired[Nullable[str]] r"""Reference to supplier bill number""" 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""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" currency: NotRequired[Nullable[Currency]] r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" currency_rate: NotRequired[Nullable[float]] @@ -415,6 +482,16 @@ class BillInputTypedDict(TypedDict): bank_account: NotRequired[BankAccountTypedDict] discount_percentage: NotRequired[Nullable[float]] r"""Discount percentage applied to this transaction.""" + template_id: NotRequired[Nullable[str]] + r"""Optional bill template""" + approved_by: NotRequired[Nullable[str]] + r"""The user who approved the bill""" + amortization_type: NotRequired[Nullable[AmortizationType]] + r"""Type of amortization""" + tax_method: NotRequired[Nullable[str]] + r"""Method of tax calculation""" + document_received: NotRequired[Nullable[bool]] + r"""Whether the document has been received""" source_document_url: NotRequired[Nullable[str]] r"""URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.""" tracking_categories: NotRequired[ @@ -428,9 +505,13 @@ class BillInputTypedDict(TypedDict): 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""" + attachments: NotRequired[List[Nullable[LinkedAttachmentTypedDict]]] class BillInput(BaseModel): + display_id: OptionalNullable[str] = UNSET + r"""Id to be displayed.""" + bill_number: OptionalNullable[str] = UNSET r"""Reference to supplier bill number""" @@ -438,7 +519,10 @@ class BillInput(BaseModel): r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" currency: OptionalNullable[Currency] = UNSET r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" @@ -511,6 +595,21 @@ class BillInput(BaseModel): discount_percentage: OptionalNullable[float] = UNSET r"""Discount percentage applied to this transaction.""" + template_id: OptionalNullable[str] = UNSET + r"""Optional bill template""" + + approved_by: OptionalNullable[str] = UNSET + r"""The user who approved the bill""" + + amortization_type: OptionalNullable[AmortizationType] = UNSET + r"""Type of amortization""" + + tax_method: OptionalNullable[str] = UNSET + r"""Method of tax calculation""" + + document_received: OptionalNullable[bool] = UNSET + r"""Whether the document has been received""" + source_document_url: OptionalNullable[str] = UNSET r"""URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.""" @@ -530,12 +629,16 @@ class BillInput(BaseModel): accounting_period: OptionalNullable[str] = UNSET r"""Accounting period""" + attachments: Optional[List[Nullable[LinkedAttachment]]] = None + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "display_id", "bill_number", "supplier", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", @@ -561,17 +664,25 @@ def serialize_model(self, handler): "accounting_by_row", "bank_account", "discount_percentage", + "template_id", + "approved_by", + "amortization_type", + "tax_method", + "document_received", "source_document_url", "tracking_categories", "row_version", "custom_fields", "pass_through", "accounting_period", + "attachments", ] nullable_fields = [ + "display_id", "bill_number", "supplier", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", @@ -595,6 +706,11 @@ def serialize_model(self, handler): "language", "accounting_by_row", "discount_percentage", + "template_id", + "approved_by", + "amortization_type", + "tax_method", + "document_received", "source_document_url", "tracking_categories", "row_version", diff --git a/src/apideck_unify/models/billlineitem.py b/src/apideck_unify/models/billlineitem.py index f9fa302d..e6ced1a8 100644 --- a/src/apideck_unify/models/billlineitem.py +++ b/src/apideck_unify/models/billlineitem.py @@ -16,6 +16,7 @@ LinkedTrackingCategory, LinkedTrackingCategoryTypedDict, ) +from .linkedworktag import LinkedWorktag, LinkedWorktagTypedDict from .rebilling import Rebilling, RebillingTypedDict from apideck_unify.types import ( BaseModel, @@ -72,6 +73,22 @@ class BillLineItemTypedDict(TypedDict): r"""The ID of the subsidiary""" category_id: NotRequired[Nullable[str]] r"""ID of the category of the line item""" + shipping_id: NotRequired[Nullable[str]] + r"""ID of the shipping of the line item""" + memo: NotRequired[Nullable[str]] + r"""Memo""" + prepaid: NotRequired[Nullable[bool]] + r"""Whether the line item is prepaid""" + tax_applicable_on: NotRequired[Nullable[str]] + r"""Tax applicable on""" + tax_recoverability: NotRequired[Nullable[str]] + r"""Tax recoverability""" + tax_method: NotRequired[Nullable[str]] + r"""Method of tax calculation""" + retention_amount: NotRequired[Nullable[float]] + r"""Retention amount""" + payment_amount: NotRequired[Nullable[float]] + r"""Payment amount""" item: NotRequired[LinkedInvoiceItemTypedDict] tax_rate: NotRequired[LinkedTaxRateTypedDict] ledger_account: NotRequired[Nullable[LinkedLedgerAccountTypedDict]] @@ -94,6 +111,8 @@ class BillLineItemTypedDict(TypedDict): r"""The date and time when the object was created.""" updated_at: NotRequired[Nullable[datetime]] r"""The date and time when the object was last updated.""" + worktags: NotRequired[List[Nullable[LinkedWorktagTypedDict]]] + r"""A list of linked worktags. This is only supported for Workday.""" class BillLineItem(BaseModel): @@ -146,6 +165,30 @@ class BillLineItem(BaseModel): category_id: OptionalNullable[str] = UNSET r"""ID of the category of the line item""" + shipping_id: OptionalNullable[str] = UNSET + r"""ID of the shipping of the line item""" + + memo: OptionalNullable[str] = UNSET + r"""Memo""" + + prepaid: OptionalNullable[bool] = UNSET + r"""Whether the line item is prepaid""" + + tax_applicable_on: OptionalNullable[str] = UNSET + r"""Tax applicable on""" + + tax_recoverability: OptionalNullable[str] = UNSET + r"""Tax recoverability""" + + tax_method: OptionalNullable[str] = UNSET + r"""Method of tax calculation""" + + retention_amount: OptionalNullable[float] = UNSET + r"""Retention amount""" + + payment_amount: OptionalNullable[float] = UNSET + r"""Payment amount""" + item: Optional[LinkedInvoiceItem] = None tax_rate: Optional[LinkedTaxRate] = None @@ -180,6 +223,9 @@ class BillLineItem(BaseModel): updated_at: OptionalNullable[datetime] = UNSET r"""The date and time when the object was last updated.""" + worktags: Optional[List[Nullable[LinkedWorktag]]] = None + r"""A list of linked worktags. This is only supported for Workday.""" + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ @@ -200,6 +246,14 @@ def serialize_model(self, handler): "department_id", "subsidiary_id", "category_id", + "shipping_id", + "memo", + "prepaid", + "tax_applicable_on", + "tax_recoverability", + "tax_method", + "retention_amount", + "payment_amount", "item", "tax_rate", "ledger_account", @@ -212,6 +266,7 @@ def serialize_model(self, handler): "created_by", "created_at", "updated_at", + "worktags", ] nullable_fields = [ "code", @@ -229,6 +284,14 @@ def serialize_model(self, handler): "department_id", "subsidiary_id", "category_id", + "shipping_id", + "memo", + "prepaid", + "tax_applicable_on", + "tax_recoverability", + "tax_method", + "retention_amount", + "payment_amount", "ledger_account", "purchase_order", "tracking_categories", @@ -298,6 +361,22 @@ class BillLineItemInputTypedDict(TypedDict): r"""The ID of the subsidiary""" category_id: NotRequired[Nullable[str]] r"""ID of the category of the line item""" + shipping_id: NotRequired[Nullable[str]] + r"""ID of the shipping of the line item""" + memo: NotRequired[Nullable[str]] + r"""Memo""" + prepaid: NotRequired[Nullable[bool]] + r"""Whether the line item is prepaid""" + tax_applicable_on: NotRequired[Nullable[str]] + r"""Tax applicable on""" + tax_recoverability: NotRequired[Nullable[str]] + r"""Tax recoverability""" + tax_method: NotRequired[Nullable[str]] + r"""Method of tax calculation""" + retention_amount: NotRequired[Nullable[float]] + r"""Retention amount""" + payment_amount: NotRequired[Nullable[float]] + r"""Payment amount""" item: NotRequired[LinkedInvoiceItemTypedDict] tax_rate: NotRequired[LinkedTaxRateInputTypedDict] ledger_account: NotRequired[Nullable[LinkedLedgerAccountInputTypedDict]] @@ -312,6 +391,8 @@ class BillLineItemInputTypedDict(TypedDict): r"""Rebilling metadata for this line item.""" 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.""" + worktags: NotRequired[List[Nullable[LinkedWorktagTypedDict]]] + r"""A list of linked worktags. This is only supported for Workday.""" class BillLineItemInput(BaseModel): @@ -361,6 +442,30 @@ class BillLineItemInput(BaseModel): category_id: OptionalNullable[str] = UNSET r"""ID of the category of the line item""" + shipping_id: OptionalNullable[str] = UNSET + r"""ID of the shipping of the line item""" + + memo: OptionalNullable[str] = UNSET + r"""Memo""" + + prepaid: OptionalNullable[bool] = UNSET + r"""Whether the line item is prepaid""" + + tax_applicable_on: OptionalNullable[str] = UNSET + r"""Tax applicable on""" + + tax_recoverability: OptionalNullable[str] = UNSET + r"""Tax recoverability""" + + tax_method: OptionalNullable[str] = UNSET + r"""Method of tax calculation""" + + retention_amount: OptionalNullable[float] = UNSET + r"""Retention amount""" + + payment_amount: OptionalNullable[float] = UNSET + r"""Payment amount""" + item: Optional[LinkedInvoiceItem] = None tax_rate: Optional[LinkedTaxRateInput] = None @@ -383,6 +488,9 @@ class BillLineItemInput(BaseModel): 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.""" + worktags: Optional[List[Nullable[LinkedWorktag]]] = None + r"""A list of linked worktags. This is only supported for Workday.""" + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ @@ -402,6 +510,14 @@ def serialize_model(self, handler): "department_id", "subsidiary_id", "category_id", + "shipping_id", + "memo", + "prepaid", + "tax_applicable_on", + "tax_recoverability", + "tax_method", + "retention_amount", + "payment_amount", "item", "tax_rate", "ledger_account", @@ -410,6 +526,7 @@ def serialize_model(self, handler): "customer", "rebilling", "row_version", + "worktags", ] nullable_fields = [ "code", @@ -427,6 +544,14 @@ def serialize_model(self, handler): "department_id", "subsidiary_id", "category_id", + "shipping_id", + "memo", + "prepaid", + "tax_applicable_on", + "tax_recoverability", + "tax_method", + "retention_amount", + "payment_amount", "ledger_account", "purchase_order", "tracking_categories", diff --git a/src/apideck_unify/models/billpayment.py b/src/apideck_unify/models/billpayment.py index 0ba0fc1a..8610abf4 100644 --- a/src/apideck_unify/models/billpayment.py +++ b/src/apideck_unify/models/billpayment.py @@ -134,7 +134,7 @@ class BillPaymentTypedDict(TypedDict): 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""" + r"""The company ID the transaction belongs to""" reconciled: NotRequired[Nullable[bool]] r"""Indicates if the transaction has been reconciled.""" status: NotRequired[PaymentStatus] @@ -206,7 +206,7 @@ class BillPayment(BaseModel): r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" reconciled: OptionalNullable[bool] = UNSET r"""Indicates if the transaction has been reconciled.""" @@ -414,7 +414,7 @@ class BillPaymentInputTypedDict(TypedDict): 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""" + r"""The company ID the transaction belongs to""" reconciled: NotRequired[Nullable[bool]] r"""Indicates if the transaction has been reconciled.""" status: NotRequired[PaymentStatus] @@ -470,7 +470,7 @@ class BillPaymentInput(BaseModel): r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" reconciled: OptionalNullable[bool] = UNSET r"""Indicates if the transaction has been reconciled.""" diff --git a/src/apideck_unify/models/creditnote.py b/src/apideck_unify/models/creditnote.py index 0f2be5af..52a64301 100644 --- a/src/apideck_unify/models/creditnote.py +++ b/src/apideck_unify/models/creditnote.py @@ -69,7 +69,9 @@ class CreditNoteTypedDict(TypedDict): 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""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" currency: NotRequired[Nullable[Currency]] r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" currency_rate: NotRequired[Nullable[float]] @@ -140,7 +142,10 @@ class CreditNote(BaseModel): r"""The customer this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" currency: OptionalNullable[Currency] = UNSET r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" @@ -231,6 +236,7 @@ def serialize_model(self, handler): "number", "customer", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", @@ -265,6 +271,7 @@ def serialize_model(self, handler): "number", "customer", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", @@ -321,7 +328,9 @@ class CreditNoteInputTypedDict(TypedDict): 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""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" currency: NotRequired[Nullable[Currency]] r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" currency_rate: NotRequired[Nullable[float]] @@ -379,7 +388,10 @@ class CreditNoteInput(BaseModel): r"""The customer this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" currency: OptionalNullable[Currency] = UNSET r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" @@ -455,6 +467,7 @@ def serialize_model(self, handler): "number", "customer", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", @@ -484,6 +497,7 @@ def serialize_model(self, handler): "number", "customer", "company_id", + "department_id", "currency", "currency_rate", "tax_inclusive", diff --git a/src/apideck_unify/models/customer.py b/src/apideck_unify/models/customer.py index 99b93573..4e2db1bd 100644 --- a/src/apideck_unify/models/customer.py +++ b/src/apideck_unify/models/customer.py @@ -53,7 +53,7 @@ class CustomerTypedDict(TypedDict): company_name: NotRequired[Nullable[str]] r"""The name of the company.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" title: NotRequired[Nullable[str]] r"""The job title of the person.""" first_name: NotRequired[Nullable[str]] @@ -121,7 +121,7 @@ class Customer(BaseModel): r"""The name of the company.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" title: OptionalNullable[str] = UNSET r"""The job title of the person.""" @@ -301,7 +301,7 @@ class CustomerInputTypedDict(TypedDict): company_name: NotRequired[Nullable[str]] r"""The name of the company.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" title: NotRequired[Nullable[str]] r"""The job title of the person.""" first_name: NotRequired[Nullable[str]] @@ -353,7 +353,7 @@ class CustomerInput(BaseModel): r"""The name of the company.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" title: OptionalNullable[str] = UNSET r"""The job title of the person.""" diff --git a/src/apideck_unify/models/expense.py b/src/apideck_unify/models/expense.py index 20f3a71d..c6dd0d11 100644 --- a/src/apideck_unify/models/expense.py +++ b/src/apideck_unify/models/expense.py @@ -53,7 +53,7 @@ class ExpenseTypedDict(TypedDict): supplier_id: NotRequired[str] r"""The ID of the supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" department_id: NotRequired[Nullable[str]] r"""The ID of the department""" payment_type: NotRequired[Nullable[ExpensePaymentType]] @@ -113,7 +113,7 @@ class Expense(BaseModel): r"""The ID of the supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" department_id: OptionalNullable[str] = UNSET r"""The ID of the department""" @@ -255,7 +255,7 @@ class ExpenseInputTypedDict(TypedDict): supplier_id: NotRequired[str] r"""The ID of the supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" department_id: NotRequired[Nullable[str]] r"""The ID of the department""" payment_type: NotRequired[Nullable[ExpensePaymentType]] @@ -302,7 +302,7 @@ class ExpenseInput(BaseModel): r"""The ID of the supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" department_id: OptionalNullable[str] = UNSET r"""The ID of the department""" diff --git a/src/apideck_unify/models/invoice.py b/src/apideck_unify/models/invoice.py index 070fee63..9844c7f7 100644 --- a/src/apideck_unify/models/invoice.py +++ b/src/apideck_unify/models/invoice.py @@ -121,6 +121,8 @@ class InvoiceTypedDict(TypedDict): r"""A unique identifier for an object.""" downstream_id: NotRequired[Nullable[str]] r"""The third-party API ID of original entity""" + display_id: NotRequired[Nullable[str]] + r"""Id to be displayed.""" type: NotRequired[Nullable[InvoiceType]] r"""Invoice type""" number: NotRequired[Nullable[str]] @@ -128,7 +130,9 @@ class InvoiceTypedDict(TypedDict): 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""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" invoice_date: NotRequired[Nullable[date]] r"""Date invoice was issued - YYYY-MM-DD.""" due_date: NotRequired[Nullable[date]] @@ -215,6 +219,9 @@ class Invoice(BaseModel): downstream_id: OptionalNullable[str] = UNSET r"""The third-party API ID of original entity""" + display_id: OptionalNullable[str] = UNSET + r"""Id to be displayed.""" + type: OptionalNullable[InvoiceType] = UNSET r"""Invoice type""" @@ -225,7 +232,10 @@ class Invoice(BaseModel): r"""The customer this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" invoice_date: OptionalNullable[date] = UNSET r"""Date invoice was issued - YYYY-MM-DD.""" @@ -355,10 +365,12 @@ def serialize_model(self, handler): optional_fields = [ "id", "downstream_id", + "display_id", "type", "number", "customer", "company_id", + "department_id", "invoice_date", "due_date", "terms", @@ -403,10 +415,12 @@ def serialize_model(self, handler): ] nullable_fields = [ "downstream_id", + "display_id", "type", "number", "customer", "company_id", + "department_id", "invoice_date", "due_date", "terms", @@ -470,6 +484,8 @@ def serialize_model(self, handler): class InvoiceInputTypedDict(TypedDict): + display_id: NotRequired[Nullable[str]] + r"""Id to be displayed.""" type: NotRequired[Nullable[InvoiceType]] r"""Invoice type""" number: NotRequired[Nullable[str]] @@ -477,7 +493,9 @@ class InvoiceInputTypedDict(TypedDict): 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""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" invoice_date: NotRequired[Nullable[date]] r"""Date invoice was issued - YYYY-MM-DD.""" due_date: NotRequired[Nullable[date]] @@ -548,6 +566,9 @@ class InvoiceInputTypedDict(TypedDict): class InvoiceInput(BaseModel): + display_id: OptionalNullable[str] = UNSET + r"""Id to be displayed.""" + type: OptionalNullable[InvoiceType] = UNSET r"""Invoice type""" @@ -558,7 +579,10 @@ class InvoiceInput(BaseModel): r"""The customer this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" invoice_date: OptionalNullable[date] = UNSET r"""Date invoice was issued - YYYY-MM-DD.""" @@ -671,10 +695,12 @@ class InvoiceInput(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "display_id", "type", "number", "customer", "company_id", + "department_id", "invoice_date", "due_date", "terms", @@ -713,10 +739,12 @@ def serialize_model(self, handler): "pass_through", ] nullable_fields = [ + "display_id", "type", "number", "customer", "company_id", + "department_id", "invoice_date", "due_date", "terms", diff --git a/src/apideck_unify/models/invoicelineitem.py b/src/apideck_unify/models/invoicelineitem.py index 9e2446b1..4e8f41ba 100644 --- a/src/apideck_unify/models/invoicelineitem.py +++ b/src/apideck_unify/models/invoicelineitem.py @@ -14,6 +14,7 @@ LinkedTrackingCategory, LinkedTrackingCategoryTypedDict, ) +from .linkedworktag import LinkedWorktag, LinkedWorktagTypedDict from apideck_unify.types import ( BaseModel, Nullable, @@ -39,14 +40,6 @@ class InvoiceLineItemType(str, Enum): OTHER = "other" -class Budget(str, Enum): - r"""Budget of the line item""" - - OUT_OF_BUDGET = "out_of_budget" - IN_BUDGET = "in_budget" - OTHER = "other" - - class InvoiceLineItemTypedDict(TypedDict): id: NotRequired[Nullable[str]] r"""A unique identifier for an object.""" @@ -93,10 +86,8 @@ class InvoiceLineItemTypedDict(TypedDict): r"""Tax recoverability""" tax_method: NotRequired[Nullable[str]] r"""Method of tax calculation""" - budget: NotRequired[Nullable[Budget]] - r"""Budget of the line item""" - project_id: NotRequired[Nullable[str]] - r"""ID of the project of the line item""" + worktags: NotRequired[List[Nullable[LinkedWorktagTypedDict]]] + r"""Worktags of the line item. This is currently only supported in Workday.""" tax_rate: NotRequired[LinkedTaxRateTypedDict] tracking_categories: NotRequired[ Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] @@ -186,11 +177,8 @@ class InvoiceLineItem(BaseModel): tax_method: OptionalNullable[str] = UNSET r"""Method of tax calculation""" - budget: OptionalNullable[Budget] = UNSET - r"""Budget of the line item""" - - project_id: OptionalNullable[str] = UNSET - r"""ID of the project of the line item""" + worktags: Optional[List[Nullable[LinkedWorktag]]] = None + r"""Worktags of the line item. This is currently only supported in Workday.""" tax_rate: Optional[LinkedTaxRate] = None @@ -245,8 +233,7 @@ def serialize_model(self, handler): "tax_applicable_on", "tax_recoverability", "tax_method", - "budget", - "project_id", + "worktags", "tax_rate", "tracking_categories", "ledger_account", @@ -280,8 +267,6 @@ def serialize_model(self, handler): "tax_applicable_on", "tax_recoverability", "tax_method", - "budget", - "project_id", "tracking_categories", "ledger_account", "row_version", @@ -363,10 +348,8 @@ class InvoiceLineItemInputTypedDict(TypedDict): r"""Tax recoverability""" tax_method: NotRequired[Nullable[str]] r"""Method of tax calculation""" - budget: NotRequired[Nullable[Budget]] - r"""Budget of the line item""" - project_id: NotRequired[Nullable[str]] - r"""ID of the project of the line item""" + worktags: NotRequired[List[Nullable[LinkedWorktagTypedDict]]] + r"""Worktags of the line item. This is currently only supported in Workday.""" tax_rate: NotRequired[LinkedTaxRateInputTypedDict] tracking_categories: NotRequired[ Nullable[List[Nullable[LinkedTrackingCategoryTypedDict]]] @@ -448,11 +431,8 @@ class InvoiceLineItemInput(BaseModel): tax_method: OptionalNullable[str] = UNSET r"""Method of tax calculation""" - budget: OptionalNullable[Budget] = UNSET - r"""Budget of the line item""" - - project_id: OptionalNullable[str] = UNSET - r"""ID of the project of the line item""" + worktags: Optional[List[Nullable[LinkedWorktag]]] = None + r"""Worktags of the line item. This is currently only supported in Workday.""" tax_rate: Optional[LinkedTaxRateInput] = None @@ -495,8 +475,7 @@ def serialize_model(self, handler): "tax_applicable_on", "tax_recoverability", "tax_method", - "budget", - "project_id", + "worktags", "tax_rate", "tracking_categories", "ledger_account", @@ -526,8 +505,6 @@ def serialize_model(self, handler): "tax_applicable_on", "tax_recoverability", "tax_method", - "budget", - "project_id", "tracking_categories", "ledger_account", "row_version", diff --git a/src/apideck_unify/models/journalentry.py b/src/apideck_unify/models/journalentry.py index 969847fa..3bfb803f 100644 --- a/src/apideck_unify/models/journalentry.py +++ b/src/apideck_unify/models/journalentry.py @@ -51,7 +51,7 @@ class JournalEntryTypedDict(TypedDict): currency: NotRequired[Nullable[Currency]] r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" line_items: NotRequired[List[JournalEntryLineItemTypedDict]] r"""Requires a minimum of 2 line items that sum to 0""" status: NotRequired[Nullable[JournalEntryStatus]] @@ -105,7 +105,7 @@ class JournalEntry(BaseModel): r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" line_items: Optional[List[JournalEntryLineItem]] = None r"""Requires a minimum of 2 line items that sum to 0""" @@ -244,7 +244,7 @@ class JournalEntryInputTypedDict(TypedDict): currency: NotRequired[Nullable[Currency]] r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" line_items: NotRequired[List[JournalEntryLineItemInputTypedDict]] r"""Requires a minimum of 2 line items that sum to 0""" status: NotRequired[Nullable[JournalEntryStatus]] @@ -285,7 +285,7 @@ class JournalEntryInput(BaseModel): r"""Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" line_items: Optional[List[JournalEntryLineItemInput]] = None r"""Requires a minimum of 2 line items that sum to 0""" diff --git a/src/apideck_unify/models/linkedattachment.py b/src/apideck_unify/models/linkedattachment.py new file mode 100644 index 00000000..1ee02ed9 --- /dev/null +++ b/src/apideck_unify/models/linkedattachment.py @@ -0,0 +1,91 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from apideck_unify.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) +from pydantic import model_serializer +from typing_extensions import NotRequired, TypedDict + + +class LinkedAttachmentTypedDict(TypedDict): + name: NotRequired[Nullable[str]] + r"""The name of the file""" + mime_type: NotRequired[Nullable[str]] + r"""The MIME type of the file.""" + is_compressed: NotRequired[Nullable[bool]] + r"""Whether the file is c ompressed.""" + encoding: NotRequired[Nullable[str]] + r"""The encoding of the file.""" + content: NotRequired[Nullable[str]] + r"""The content of the file.""" + notes: NotRequired[Nullable[str]] + r"""The notes of the file.""" + + +class LinkedAttachment(BaseModel): + name: OptionalNullable[str] = UNSET + r"""The name of the file""" + + mime_type: OptionalNullable[str] = UNSET + r"""The MIME type of the file.""" + + is_compressed: OptionalNullable[bool] = UNSET + r"""Whether the file is c ompressed.""" + + encoding: OptionalNullable[str] = UNSET + r"""The encoding of the file.""" + + content: OptionalNullable[str] = UNSET + r"""The content of the file.""" + + notes: OptionalNullable[str] = UNSET + r"""The notes of the file.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "name", + "mime_type", + "is_compressed", + "encoding", + "content", + "notes", + ] + nullable_fields = [ + "name", + "mime_type", + "is_compressed", + "encoding", + "content", + "notes", + ] + 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/linkedworktag.py b/src/apideck_unify/models/linkedworktag.py new file mode 100644 index 00000000..f8e6c8f6 --- /dev/null +++ b/src/apideck_unify/models/linkedworktag.py @@ -0,0 +1,58 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from apideck_unify.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) +from pydantic import model_serializer +from typing import Optional +from typing_extensions import NotRequired, TypedDict + + +class LinkedWorktagTypedDict(TypedDict): + id: NotRequired[str] + r"""The unique identifier for the worktag.""" + value: NotRequired[Nullable[str]] + r"""The value of the worktag.""" + + +class LinkedWorktag(BaseModel): + id: Optional[str] = None + r"""The unique identifier for the worktag.""" + + value: OptionalNullable[str] = UNSET + r"""The value of the worktag.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["id", "value"] + nullable_fields = ["value"] + 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/payment.py b/src/apideck_unify/models/payment.py index 8eea53b9..2f81e9a1 100644 --- a/src/apideck_unify/models/payment.py +++ b/src/apideck_unify/models/payment.py @@ -62,7 +62,7 @@ class PaymentTypedDict(TypedDict): supplier: NotRequired[Nullable[DeprecatedLinkedSupplierTypedDict]] r"""The supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" reconciled: NotRequired[Nullable[bool]] r"""Indicates if the transaction has been reconciled.""" status: NotRequired[PaymentStatus] @@ -158,7 +158,7 @@ class Payment(BaseModel): r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" reconciled: OptionalNullable[bool] = UNSET r"""Indicates if the transaction has been reconciled.""" diff --git a/src/apideck_unify/models/payment_input.py b/src/apideck_unify/models/payment_input.py index 44a1b4a8..c95fe1af 100644 --- a/src/apideck_unify/models/payment_input.py +++ b/src/apideck_unify/models/payment_input.py @@ -61,7 +61,7 @@ class PaymentInputTypedDict(TypedDict): supplier: NotRequired[Nullable[DeprecatedLinkedSupplierInputTypedDict]] r"""The supplier this entity is linked to.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" reconciled: NotRequired[Nullable[bool]] r"""Indicates if the transaction has been reconciled.""" status: NotRequired[PaymentStatus] @@ -141,7 +141,7 @@ class PaymentInput(BaseModel): r"""The supplier this entity is linked to.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" reconciled: OptionalNullable[bool] = UNSET r"""Indicates if the transaction has been reconciled.""" diff --git a/src/apideck_unify/models/purchaseorder.py b/src/apideck_unify/models/purchaseorder.py index 18225d52..9cf9612b 100644 --- a/src/apideck_unify/models/purchaseorder.py +++ b/src/apideck_unify/models/purchaseorder.py @@ -46,7 +46,7 @@ class PurchaseOrderStatus(str, Enum): OTHER = "other" -class AmortizationType(str, Enum): +class PurchaseOrderAmortizationType(str, Enum): r"""Type of amortization""" MANUAL = "manual" @@ -69,7 +69,9 @@ class PurchaseOrderTypedDict(TypedDict): subsidiary_id: NotRequired[Nullable[str]] r"""The ID of the subsidiary""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" status: NotRequired[Nullable[PurchaseOrderStatus]] issued_date: NotRequired[Nullable[date]] r"""Date purchase order was issued - YYYY-MM-DD.""" @@ -106,7 +108,7 @@ class PurchaseOrderTypedDict(TypedDict): r"""Payment method used for the transaction, such as cash, credit card, bank transfer, or check""" terms: NotRequired[Nullable[str]] r"""Terms of payment.""" - amortization_type: NotRequired[Nullable[AmortizationType]] + amortization_type: NotRequired[Nullable[PurchaseOrderAmortizationType]] r"""Type of amortization""" tax_code: NotRequired[Nullable[str]] r"""Applicable tax id/code override if tax is not supplied on a line item basis.""" @@ -163,7 +165,10 @@ class PurchaseOrder(BaseModel): r"""The ID of the subsidiary""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" status: OptionalNullable[PurchaseOrderStatus] = UNSET @@ -222,7 +227,7 @@ class PurchaseOrder(BaseModel): terms: OptionalNullable[str] = UNSET r"""Terms of payment.""" - amortization_type: OptionalNullable[AmortizationType] = UNSET + amortization_type: OptionalNullable[PurchaseOrderAmortizationType] = UNSET r"""Type of amortization""" tax_code: OptionalNullable[str] = UNSET @@ -284,6 +289,7 @@ def serialize_model(self, handler): "supplier", "subsidiary_id", "company_id", + "department_id", "status", "issued_date", "delivery_date", @@ -330,6 +336,7 @@ def serialize_model(self, handler): "supplier", "subsidiary_id", "company_id", + "department_id", "status", "issued_date", "delivery_date", @@ -400,7 +407,9 @@ class PurchaseOrderInputTypedDict(TypedDict): subsidiary_id: NotRequired[Nullable[str]] r"""The ID of the subsidiary""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" status: NotRequired[Nullable[PurchaseOrderStatus]] issued_date: NotRequired[Nullable[date]] r"""Date purchase order was issued - YYYY-MM-DD.""" @@ -437,7 +446,7 @@ class PurchaseOrderInputTypedDict(TypedDict): r"""Payment method used for the transaction, such as cash, credit card, bank transfer, or check""" terms: NotRequired[Nullable[str]] r"""Terms of payment.""" - amortization_type: NotRequired[Nullable[AmortizationType]] + amortization_type: NotRequired[Nullable[PurchaseOrderAmortizationType]] r"""Type of amortization""" tax_code: NotRequired[Nullable[str]] r"""Applicable tax id/code override if tax is not supplied on a line item basis.""" @@ -478,7 +487,10 @@ class PurchaseOrderInput(BaseModel): r"""The ID of the subsidiary""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" status: OptionalNullable[PurchaseOrderStatus] = UNSET @@ -537,7 +549,7 @@ class PurchaseOrderInput(BaseModel): terms: OptionalNullable[str] = UNSET r"""Terms of payment.""" - amortization_type: OptionalNullable[AmortizationType] = UNSET + amortization_type: OptionalNullable[PurchaseOrderAmortizationType] = UNSET r"""Type of amortization""" tax_code: OptionalNullable[str] = UNSET @@ -582,6 +594,7 @@ def serialize_model(self, handler): "supplier", "subsidiary_id", "company_id", + "department_id", "status", "issued_date", "delivery_date", @@ -622,6 +635,7 @@ def serialize_model(self, handler): "supplier", "subsidiary_id", "company_id", + "department_id", "status", "issued_date", "delivery_date", diff --git a/src/apideck_unify/models/quote.py b/src/apideck_unify/models/quote.py index 61c18b2a..c9e8758b 100644 --- a/src/apideck_unify/models/quote.py +++ b/src/apideck_unify/models/quote.py @@ -58,7 +58,9 @@ class QuoteTypedDict(TypedDict): sales_order_id: NotRequired[Nullable[str]] r"""The unique identifier for the sales order.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" project_id: NotRequired[str] r"""The unique identifier for the linked project.""" quote_date: NotRequired[Nullable[date]] @@ -137,7 +139,10 @@ class Quote(BaseModel): r"""The unique identifier for the sales order.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" project_id: Optional[str] = None r"""The unique identifier for the linked project.""" @@ -234,6 +239,7 @@ def serialize_model(self, handler): "invoice_id", "sales_order_id", "company_id", + "department_id", "project_id", "quote_date", "expiry_date", @@ -270,6 +276,7 @@ def serialize_model(self, handler): "customer", "sales_order_id", "company_id", + "department_id", "quote_date", "expiry_date", "terms", @@ -329,7 +336,9 @@ class QuoteInputTypedDict(TypedDict): sales_order_id: NotRequired[Nullable[str]] r"""The unique identifier for the sales order.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + department_id: NotRequired[Nullable[str]] + r"""The ID of the department""" project_id: NotRequired[str] r"""The unique identifier for the linked project.""" quote_date: NotRequired[Nullable[date]] @@ -391,7 +400,10 @@ class QuoteInput(BaseModel): r"""The unique identifier for the sales order.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" + + department_id: OptionalNullable[str] = UNSET + r"""The ID of the department""" project_id: Optional[str] = None r"""The unique identifier for the linked project.""" @@ -473,6 +485,7 @@ def serialize_model(self, handler): "customer", "sales_order_id", "company_id", + "department_id", "project_id", "quote_date", "expiry_date", @@ -504,6 +517,7 @@ def serialize_model(self, handler): "customer", "sales_order_id", "company_id", + "department_id", "quote_date", "expiry_date", "terms", diff --git a/src/apideck_unify/models/supplier.py b/src/apideck_unify/models/supplier.py index 54eacdd4..0fb07dd5 100644 --- a/src/apideck_unify/models/supplier.py +++ b/src/apideck_unify/models/supplier.py @@ -52,7 +52,7 @@ class SupplierTypedDict(TypedDict): company_name: NotRequired[Nullable[str]] r"""The name of the company.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" supplier_category: NotRequired[Nullable[str]] r"""The category/type of the supplier""" title: NotRequired[Nullable[str]] @@ -122,7 +122,7 @@ class Supplier(BaseModel): r"""The name of the company.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" supplier_category: OptionalNullable[str] = UNSET r"""The category/type of the supplier""" @@ -306,7 +306,7 @@ class SupplierInputTypedDict(TypedDict): company_name: NotRequired[Nullable[str]] r"""The name of the company.""" company_id: NotRequired[Nullable[str]] - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" supplier_category: NotRequired[Nullable[str]] r"""The category/type of the supplier""" title: NotRequired[Nullable[str]] @@ -360,7 +360,7 @@ class SupplierInput(BaseModel): r"""The name of the company.""" company_id: OptionalNullable[str] = UNSET - r"""The company or subsidiary id the transaction belongs to""" + r"""The company ID the transaction belongs to""" supplier_category: OptionalNullable[str] = UNSET r"""The category/type of the supplier""" diff --git a/src/apideck_unify/payments.py b/src/apideck_unify/payments.py index 66800b2a..26beb756 100644 --- a/src/apideck_unify/payments.py +++ b/src/apideck_unify/payments.py @@ -463,7 +463,7 @@ def create( :param account: :param customer: The customer this entity is linked to. :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment @@ -719,7 +719,7 @@ async def create_async( :param account: :param customer: The customer this entity is linked to. :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment @@ -1265,7 +1265,7 @@ def update( :param account: :param customer: The customer this entity is linked to. :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment @@ -1524,7 +1524,7 @@ async def update_async( :param account: :param customer: The customer this entity is linked to. :param supplier: The supplier this entity is linked to. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param reconciled: Indicates if the transaction has been reconciled. :param status: Status of payment :param type: Type of payment diff --git a/src/apideck_unify/purchaseorders.py b/src/apideck_unify/purchaseorders.py index 887ba02d..ef04be04 100644 --- a/src/apideck_unify/purchaseorders.py +++ b/src/apideck_unify/purchaseorders.py @@ -396,6 +396,7 @@ def create( ] = UNSET, subsidiary_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, status: OptionalNullable[models.PurchaseOrderStatus] = UNSET, issued_date: OptionalNullable[date] = UNSET, delivery_date: OptionalNullable[date] = UNSET, @@ -433,7 +434,9 @@ def create( due_date: OptionalNullable[date] = UNSET, payment_method: OptionalNullable[str] = UNSET, terms: OptionalNullable[str] = UNSET, - amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + amortization_type: OptionalNullable[ + models.PurchaseOrderAmortizationType + ] = UNSET, tax_code: OptionalNullable[str] = UNSET, tax_method: OptionalNullable[str] = UNSET, issued_method: OptionalNullable[str] = UNSET, @@ -471,7 +474,8 @@ def create( :param reference: Optional purchase order reference. :param supplier: The supplier this entity is linked to. :param subsidiary_id: The ID of the subsidiary - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param status: :param issued_date: Date purchase order was issued - YYYY-MM-DD. :param delivery_date: The date on which the purchase order is to be delivered - YYYY-MM-DD. @@ -533,6 +537,7 @@ def create( ), subsidiary_id=subsidiary_id, company_id=company_id, + department_id=department_id, status=status, issued_date=issued_date, delivery_date=delivery_date, @@ -699,6 +704,7 @@ async def create_async( ] = UNSET, subsidiary_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, status: OptionalNullable[models.PurchaseOrderStatus] = UNSET, issued_date: OptionalNullable[date] = UNSET, delivery_date: OptionalNullable[date] = UNSET, @@ -736,7 +742,9 @@ async def create_async( due_date: OptionalNullable[date] = UNSET, payment_method: OptionalNullable[str] = UNSET, terms: OptionalNullable[str] = UNSET, - amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + amortization_type: OptionalNullable[ + models.PurchaseOrderAmortizationType + ] = UNSET, tax_code: OptionalNullable[str] = UNSET, tax_method: OptionalNullable[str] = UNSET, issued_method: OptionalNullable[str] = UNSET, @@ -774,7 +782,8 @@ async def create_async( :param reference: Optional purchase order reference. :param supplier: The supplier this entity is linked to. :param subsidiary_id: The ID of the subsidiary - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param status: :param issued_date: Date purchase order was issued - YYYY-MM-DD. :param delivery_date: The date on which the purchase order is to be delivered - YYYY-MM-DD. @@ -836,6 +845,7 @@ async def create_async( ), subsidiary_id=subsidiary_id, company_id=company_id, + department_id=department_id, status=status, issued_date=issued_date, delivery_date=delivery_date, @@ -1285,6 +1295,7 @@ def update( ] = UNSET, subsidiary_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, status: OptionalNullable[models.PurchaseOrderStatus] = UNSET, issued_date: OptionalNullable[date] = UNSET, delivery_date: OptionalNullable[date] = UNSET, @@ -1322,7 +1333,9 @@ def update( due_date: OptionalNullable[date] = UNSET, payment_method: OptionalNullable[str] = UNSET, terms: OptionalNullable[str] = UNSET, - amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + amortization_type: OptionalNullable[ + models.PurchaseOrderAmortizationType + ] = UNSET, tax_code: OptionalNullable[str] = UNSET, tax_method: OptionalNullable[str] = UNSET, issued_method: OptionalNullable[str] = UNSET, @@ -1361,7 +1374,8 @@ def update( :param reference: Optional purchase order reference. :param supplier: The supplier this entity is linked to. :param subsidiary_id: The ID of the subsidiary - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param status: :param issued_date: Date purchase order was issued - YYYY-MM-DD. :param delivery_date: The date on which the purchase order is to be delivered - YYYY-MM-DD. @@ -1424,6 +1438,7 @@ def update( ), subsidiary_id=subsidiary_id, company_id=company_id, + department_id=department_id, status=status, issued_date=issued_date, delivery_date=delivery_date, @@ -1591,6 +1606,7 @@ async def update_async( ] = UNSET, subsidiary_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, status: OptionalNullable[models.PurchaseOrderStatus] = UNSET, issued_date: OptionalNullable[date] = UNSET, delivery_date: OptionalNullable[date] = UNSET, @@ -1628,7 +1644,9 @@ async def update_async( due_date: OptionalNullable[date] = UNSET, payment_method: OptionalNullable[str] = UNSET, terms: OptionalNullable[str] = UNSET, - amortization_type: OptionalNullable[models.AmortizationType] = UNSET, + amortization_type: OptionalNullable[ + models.PurchaseOrderAmortizationType + ] = UNSET, tax_code: OptionalNullable[str] = UNSET, tax_method: OptionalNullable[str] = UNSET, issued_method: OptionalNullable[str] = UNSET, @@ -1667,7 +1685,8 @@ async def update_async( :param reference: Optional purchase order reference. :param supplier: The supplier this entity is linked to. :param subsidiary_id: The ID of the subsidiary - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param status: :param issued_date: Date purchase order was issued - YYYY-MM-DD. :param delivery_date: The date on which the purchase order is to be delivered - YYYY-MM-DD. @@ -1730,6 +1749,7 @@ async def update_async( ), subsidiary_id=subsidiary_id, company_id=company_id, + department_id=department_id, status=status, issued_date=issued_date, delivery_date=delivery_date, diff --git a/src/apideck_unify/quotes.py b/src/apideck_unify/quotes.py index c4469539..d49f934e 100644 --- a/src/apideck_unify/quotes.py +++ b/src/apideck_unify/quotes.py @@ -359,6 +359,7 @@ def create( ] = UNSET, sales_order_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, project_id: Optional[str] = None, quote_date: OptionalNullable[date] = UNSET, expiry_date: OptionalNullable[date] = UNSET, @@ -418,7 +419,8 @@ def create( :param number: Quote number. :param customer: The customer this entity is linked to. :param sales_order_id: The unique identifier for the sales order. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param project_id: The unique identifier for the linked project. :param quote_date: Date quote was issued - YYYY-MM-DD. :param expiry_date: The date until which the quote is valid - YYYY-MM-DD. @@ -471,6 +473,7 @@ def create( ), sales_order_id=sales_order_id, company_id=company_id, + department_id=department_id, project_id=project_id, quote_date=quote_date, expiry_date=expiry_date, @@ -624,6 +627,7 @@ async def create_async( ] = UNSET, sales_order_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, project_id: Optional[str] = None, quote_date: OptionalNullable[date] = UNSET, expiry_date: OptionalNullable[date] = UNSET, @@ -683,7 +687,8 @@ async def create_async( :param number: Quote number. :param customer: The customer this entity is linked to. :param sales_order_id: The unique identifier for the sales order. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param project_id: The unique identifier for the linked project. :param quote_date: Date quote was issued - YYYY-MM-DD. :param expiry_date: The date until which the quote is valid - YYYY-MM-DD. @@ -736,6 +741,7 @@ async def create_async( ), sales_order_id=sales_order_id, company_id=company_id, + department_id=department_id, project_id=project_id, quote_date=quote_date, expiry_date=expiry_date, @@ -1172,6 +1178,7 @@ def update( ] = UNSET, sales_order_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, project_id: Optional[str] = None, quote_date: OptionalNullable[date] = UNSET, expiry_date: OptionalNullable[date] = UNSET, @@ -1232,7 +1239,8 @@ def update( :param number: Quote number. :param customer: The customer this entity is linked to. :param sales_order_id: The unique identifier for the sales order. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param project_id: The unique identifier for the linked project. :param quote_date: Date quote was issued - YYYY-MM-DD. :param expiry_date: The date until which the quote is valid - YYYY-MM-DD. @@ -1286,6 +1294,7 @@ def update( ), sales_order_id=sales_order_id, company_id=company_id, + department_id=department_id, project_id=project_id, quote_date=quote_date, expiry_date=expiry_date, @@ -1440,6 +1449,7 @@ async def update_async( ] = UNSET, sales_order_id: OptionalNullable[str] = UNSET, company_id: OptionalNullable[str] = UNSET, + department_id: OptionalNullable[str] = UNSET, project_id: Optional[str] = None, quote_date: OptionalNullable[date] = UNSET, expiry_date: OptionalNullable[date] = UNSET, @@ -1500,7 +1510,8 @@ async def update_async( :param number: Quote number. :param customer: The customer this entity is linked to. :param sales_order_id: The unique identifier for the sales order. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to + :param department_id: The ID of the department :param project_id: The unique identifier for the linked project. :param quote_date: Date quote was issued - YYYY-MM-DD. :param expiry_date: The date until which the quote is valid - YYYY-MM-DD. @@ -1554,6 +1565,7 @@ async def update_async( ), sales_order_id=sales_order_id, company_id=company_id, + department_id=department_id, project_id=project_id, quote_date=quote_date, expiry_date=expiry_date, diff --git a/src/apideck_unify/suppliers.py b/src/apideck_unify/suppliers.py index d259dc5a..fcf24310 100644 --- a/src/apideck_unify/suppliers.py +++ b/src/apideck_unify/suppliers.py @@ -456,7 +456,7 @@ def create( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param supplier_category: The category/type of the supplier :param title: The job title of the person. :param first_name: The first name of the person. @@ -721,7 +721,7 @@ async def create_async( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param supplier_category: The category/type of the supplier :param title: The job title of the person. :param first_name: The first name of the person. @@ -1276,7 +1276,7 @@ def update( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param supplier_category: The category/type of the supplier :param title: The job title of the person. :param first_name: The first name of the person. @@ -1544,7 +1544,7 @@ async def update_async( :param display_id: Display ID :param display_name: Display name :param company_name: The name of the company. - :param company_id: The company or subsidiary id the transaction belongs to + :param company_id: The company ID the transaction belongs to :param supplier_category: The category/type of the supplier :param title: The job title of the person. :param first_name: The first name of the person. From 7c1b8646b4b35497d9dbe68731c92f1e439ac3e5 Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Wed, 13 Aug 2025 12:40:53 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow