diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index f9de7fda..5cccdd06 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 7bffa198-5d29-4efa-9942-d549cc832085 management: - docChecksum: 11feecf9984adeb160158d1266da5ee2 - docVersion: 10.20.2 - speakeasyVersion: 1.598.3 - generationVersion: 2.674.3 - releaseVersion: 0.29.2 - configChecksum: b889fd4143e5804cfd50debc7ac9abda + docChecksum: 3508acc42fae389531f955a5c0ef2d51 + docVersion: 10.20.6 + speakeasyVersion: 1.603.0 + generationVersion: 2.681.1 + releaseVersion: 0.29.3 + configChecksum: 35e2594ec12b3548ed45aa607c87a6e6 repoURL: https://github.com/apideck-libraries/sdk-typescript.git installationURL: https://github.com/apideck-libraries/sdk-typescript published: true @@ -84,6 +84,7 @@ generatedFiles: - docs/models/components/apistatus.md - docs/models/components/apitype.md - docs/models/components/applicant.md + - docs/models/components/applicantgender.md - docs/models/components/applicantinput.md - docs/models/components/applicantsfilter.md - docs/models/components/applicanttype.md @@ -131,7 +132,6 @@ generatedFiles: - docs/models/components/billstatus.md - docs/models/components/blocks.md - docs/models/components/branch.md - - docs/models/components/budget.md - docs/models/components/by.md - docs/models/components/categories.md - docs/models/components/categoriesfilter.md @@ -607,6 +607,7 @@ generatedFiles: - docs/models/components/ledgeraccountssortby.md - docs/models/components/ledgeraccountsubsidiaries.md - docs/models/components/ledgeraccounttype.md + - docs/models/components/linkedattachment.md - docs/models/components/linkedconnectorresource.md - docs/models/components/linkedcustomer.md - docs/models/components/linkedcustomerinput.md @@ -624,6 +625,7 @@ generatedFiles: - docs/models/components/linkedtaxrate.md - docs/models/components/linkedtaxrateinput.md - docs/models/components/linkedtrackingcategory.md + - docs/models/components/linkedworktag.md - docs/models/components/links.md - docs/models/components/locationstatus.md - docs/models/components/log.md @@ -695,6 +697,7 @@ generatedFiles: - docs/models/components/profitandlosstype.md - docs/models/components/purchasedetails.md - docs/models/components/purchaseorder.md + - docs/models/components/purchaseorderamortizationtype.md - docs/models/components/purchaseorderinput.md - docs/models/components/purchaseordersfilter.md - docs/models/components/purchaseorderssort.md @@ -2624,6 +2627,7 @@ generatedFiles: - src/__tests__/mockserver/internal/sdk/models/components/ledgeraccount.go - src/__tests__/mockserver/internal/sdk/models/components/ledgeraccountsfilter.go - src/__tests__/mockserver/internal/sdk/models/components/ledgeraccountssort.go + - src/__tests__/mockserver/internal/sdk/models/components/linkedattachment.go - src/__tests__/mockserver/internal/sdk/models/components/linkedconnectorresource.go - src/__tests__/mockserver/internal/sdk/models/components/linkedcustomer.go - src/__tests__/mockserver/internal/sdk/models/components/linkedcustomerinput.go @@ -2640,6 +2644,7 @@ generatedFiles: - src/__tests__/mockserver/internal/sdk/models/components/linkedtaxrate.go - src/__tests__/mockserver/internal/sdk/models/components/linkedtaxrateinput.go - src/__tests__/mockserver/internal/sdk/models/components/linkedtrackingcategory.go + - src/__tests__/mockserver/internal/sdk/models/components/linkedworktag.go - src/__tests__/mockserver/internal/sdk/models/components/links.go - src/__tests__/mockserver/internal/sdk/models/components/log.go - src/__tests__/mockserver/internal/sdk/models/components/logsfilter.go @@ -3834,6 +3839,7 @@ generatedFiles: - src/models/components/ledgeraccount.ts - src/models/components/ledgeraccountsfilter.ts - src/models/components/ledgeraccountssort.ts + - src/models/components/linkedattachment.ts - src/models/components/linkedconnectorresource.ts - src/models/components/linkedcustomer.ts - src/models/components/linkedcustomerinput.ts @@ -3850,6 +3856,7 @@ generatedFiles: - src/models/components/linkedtaxrate.ts - src/models/components/linkedtaxrateinput.ts - src/models/components/linkedtrackingcategory.ts + - src/models/components/linkedworktag.ts - src/models/components/links.ts - src/models/components/log.ts - src/models/components/logsfilter.ts @@ -4759,7 +4766,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"}} @@ -4815,7 +4822,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": @@ -4867,7 +4874,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"}} @@ -5026,7 +5033,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"}} @@ -5082,7 +5089,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": @@ -5134,7 +5141,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"}} @@ -5829,7 +5836,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"}} @@ -5885,7 +5892,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": @@ -5937,7 +5944,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"}} @@ -7315,7 +7322,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"}} @@ -7369,7 +7376,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": @@ -7421,7 +7428,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"}} @@ -10200,7 +10207,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"}} @@ -10256,7 +10263,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": @@ -10308,7 +10315,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"}} @@ -19474,7 +19481,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"}} @@ -19503,7 +19510,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": @@ -19528,7 +19535,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 8a673a6c..4ca8403e 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -24,7 +24,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: false typescript: - version: 0.29.2 + version: 0.29.3 additionalDependencies: dependencies: {} devDependencies: {} @@ -60,4 +60,5 @@ typescript: packageName: '@apideck/unify' responseFormat: envelope-http templateVersion: v2 + usageSDKInitImports: [] useIndexModules: true diff --git a/.speakeasy/tests.arazzo.yaml b/.speakeasy/tests.arazzo.yaml index 4ba12bfc..7e0b5d8d 100644 --- a/.speakeasy/tests.arazzo.yaml +++ b/.speakeasy/tests.arazzo.yaml @@ -50991,6 +50991,7 @@ workflows: email: boring@boring.com id: "12345" customer_memo: Thank you for considering our services! + department_id: "12345" discount_amount: 25 discount_percentage: 5.5 expiry_date: "2020-10-30" @@ -51148,6 +51149,7 @@ workflows: "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", @@ -51378,6 +51380,7 @@ workflows: email: boring@boring.com id: "12345" customer_memo: Thank you for considering our services! + department_id: "12345" discount_amount: 25 discount_percentage: 5.5 expiry_date: "2020-10-30" diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index a384d44e..9ec1f7de 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.598.3 +speakeasyVersion: 1.603.0 sources: Apideck-OAS: sourceNamespace: apideck-oas - sourceRevisionDigest: sha256:89afd83629e7a3ddfd031ee44dbc0471efbcc07c3eb35b32f61260b93068de11 - sourceBlobDigest: sha256:673d93d84fd9f9165c9b1bc51442ca7ec007cbe67e55f684ebbaf8ac69afaf70 + sourceRevisionDigest: sha256:2099998270a9bdeade8ae3fb9b23b68e61f24a1908cee32bc83a8541bc58faee + sourceBlobDigest: sha256:66476ee22ff7a006e0e1b602bf1706916b1e9b06283e2afb4541ffe4ff57b851 tags: - latest - - speakeasy-sdk-regen-1754524990 - - 10.20.2 + - speakeasy-sdk-regen-1754600537 + - 10.20.6 targets: apideck: source: Apideck-OAS sourceNamespace: apideck-oas - sourceRevisionDigest: sha256:89afd83629e7a3ddfd031ee44dbc0471efbcc07c3eb35b32f61260b93068de11 - sourceBlobDigest: sha256:673d93d84fd9f9165c9b1bc51442ca7ec007cbe67e55f684ebbaf8ac69afaf70 + sourceRevisionDigest: sha256:2099998270a9bdeade8ae3fb9b23b68e61f24a1908cee32bc83a8541bc58faee + sourceBlobDigest: sha256:66476ee22ff7a006e0e1b602bf1706916b1e9b06283e2afb4541ffe4ff57b851 codeSamplesNamespace: apideck-oas-typescript-code-samples - codeSamplesRevisionDigest: sha256:ef404bf60852a1972b16ae8fa7d68499548a6b55359f7254525b156c4a8edc89 + codeSamplesRevisionDigest: sha256:b37c3b610cc7e8adc9737577c88847000e75df7d3dfd41fd8c376e106457e3fd workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index ecdff3bd..c777bbf3 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -428,4 +428,14 @@ Based on: ### Generated - [typescript v0.29.2] . ### Releases -- [NPM v0.29.2] https://www.npmjs.com/package/@apideck/unify/v/0.29.2 - . \ No newline at end of file +- [NPM v0.29.2] https://www.npmjs.com/package/@apideck/unify/v/0.29.2 - . + +## 2025-08-13 12:37:27 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.603.0 (2.681.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.29.3] . +### Releases +- [NPM v0.29.3] https://www.npmjs.com/package/@apideck/unify/v/0.29.3 - . \ No newline at end of file diff --git a/docs/models/components/applicant.md b/docs/models/components/applicant.md index 68242bc2..9eb47c64 100644 --- a/docs/models/components/applicant.md +++ b/docs/models/components/applicant.md @@ -9,11 +9,15 @@ import { RFCDate } from "@apideck/unify/types"; let value: Applicant = { id: "12345", name: "Elon Musk", + salutation: "Mr", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), + gender: "male", + socialSecurityNumber: "123456789", + type: "Candidate", coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", jobUrl: "https://democompany.recruitee.com/o/example-talent-pool", @@ -146,11 +150,15 @@ let value: Applicant = { | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `name` | *string* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | +| `salutation` | *string* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr | | `firstName` | *string* | :heavy_minus_sign: | The first name of the person. | Elon | | `lastName` | *string* | :heavy_minus_sign: | The last name of the person. | Musk | | `middleName` | *string* | :heavy_minus_sign: | Middle name of the person. | D. | | `initials` | *string* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM | | `birthday` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 | +| `gender` | [components.ApplicantGender](../../models/components/applicantgender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male | +| `socialSecurityNumber` | *string* | :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` | *string* | :heavy_minus_sign: | N/A | Candidate | | `coverLetter` | *string* | :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 ... | | `jobUrl` | *string* | :heavy_minus_sign: | N/A | https://democompany.recruitee.com/o/example-talent-pool | | `photoUrl` | *string* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk | diff --git a/docs/models/components/applicantgender.md b/docs/models/components/applicantgender.md new file mode 100644 index 00000000..a5046f3f --- /dev/null +++ b/docs/models/components/applicantgender.md @@ -0,0 +1,17 @@ +# ApplicantGender + +The gender represents the gender identity of a person. + +## Example Usage + +```typescript +import { ApplicantGender } from "@apideck/unify/models/components"; + +let value: ApplicantGender = "male"; +``` + +## Values + +```typescript +"male" | "female" | "unisex" | "other" | "not_specified" +``` \ No newline at end of file diff --git a/docs/models/components/applicantinput.md b/docs/models/components/applicantinput.md index 2920599a..c6100fe2 100644 --- a/docs/models/components/applicantinput.md +++ b/docs/models/components/applicantinput.md @@ -8,11 +8,15 @@ import { RFCDate } from "@apideck/unify/types"; let value: ApplicantInput = { name: "Elon Musk", + salutation: "Mr", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), + gender: "male", + socialSecurityNumber: "123456789", + type: "Candidate", coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photoUrl: "https://unavatar.io/elon-musk", @@ -131,11 +135,15 @@ let value: ApplicantInput = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *string* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | +| `salutation` | *string* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr | | `firstName` | *string* | :heavy_minus_sign: | The first name of the person. | Elon | | `lastName` | *string* | :heavy_minus_sign: | The last name of the person. | Musk | | `middleName` | *string* | :heavy_minus_sign: | Middle name of the person. | D. | | `initials` | *string* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM | | `birthday` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 | +| `gender` | [components.ApplicantGender](../../models/components/applicantgender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male | +| `socialSecurityNumber` | *string* | :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` | *string* | :heavy_minus_sign: | N/A | Candidate | | `coverLetter` | *string* | :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 ... | | `photoUrl` | *string* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk | | `headline` | *string* | :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/components/bill.md b/docs/models/components/bill.md index 0c4fe687..a2a06fc3 100644 --- a/docs/models/components/bill.md +++ b/docs/models/components/bill.md @@ -9,9 +9,11 @@ import { RFCDate } from "@apideck/unify/types"; let value: Bill = { id: "12345", downstreamId: "12345", + displayId: "123456", billNumber: "10001", supplier: null, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -40,6 +42,14 @@ let value: Bill = { departmentId: "12345", subsidiaryId: "12345", categoryId: "12345", + shippingId: "12345", + memo: "Some memo", + prepaid: true, + taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", + taxRecoverability: "Fully_Recoverable", + taxMethod: "Due_to_Supplier", + retentionAmount: 1000, + paymentAmount: 1000, item: { id: "12344", code: "120-C", @@ -83,6 +93,12 @@ let value: Bill = { createdBy: "12345", createdAt: new Date("2020-09-30T07:43:32.000Z"), updatedAt: new Date("2020-09-30T07:43:32.000Z"), + worktags: [ + { + id: "123456", + value: "New York", + }, + ], }, ], terms: "Net 30 days", @@ -119,6 +135,10 @@ let value: Bill = { country: "US", }, discountPercentage: 5.5, + templateId: "123456", + approvedBy: "John Doe", + taxMethod: "Due to supplier", + documentReceived: true, sourceDocumentUrl: "https://www.invoicesolution.com/bill/123456", trackingCategories: [ { @@ -157,6 +177,16 @@ let value: Bill = { }, ], accountingPeriod: "01-24", + attachments: [ + { + name: "sample.jpg", + mimeType: "image/jpeg", + isCompressed: false, + encoding: "base64", + content: "data:image/jpeg;base64,...", + notes: "A sample image", + }, + ], }; ``` @@ -166,9 +196,11 @@ let value: Bill = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `downstreamId` | *string* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | +| `displayId` | *string* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `billNumber` | *string* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | | `supplier` | [components.LinkedSupplier](../../models/components/linkedsupplier.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `currency` | [components.Currency](../../models/components/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 | | `currencyRate` | *number* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `taxInclusive` | *boolean* | :heavy_minus_sign: | Amounts are including tax | true | @@ -194,6 +226,11 @@ let value: Bill = { | `accountingByRow` | *boolean* | :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 | | `bankAccount` | [components.BankAccount](../../models/components/bankaccount.md) | :heavy_minus_sign: | N/A | | | `discountPercentage` | *number* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 | +| `templateId` | *string* | :heavy_minus_sign: | Optional bill template | 123456 | +| `approvedBy` | *string* | :heavy_minus_sign: | The user who approved the bill | John Doe | +| `amortizationType` | [components.AmortizationType](../../models/components/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | +| `documentReceived` | *boolean* | :heavy_minus_sign: | Whether the document has been received | true | | `sourceDocumentUrl` | *string* | :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 | | `trackingCategories` | [components.LinkedTrackingCategory](../../models/components/linkedtrackingcategory.md)[] | :heavy_minus_sign: | A list of linked tracking categories. | | | `updatedBy` | *string* | :heavy_minus_sign: | The user who last updated the object. | 12345 | @@ -204,4 +241,5 @@ let value: Bill = { | `customFields` | [components.CustomField](../../models/components/customfield.md)[] | :heavy_minus_sign: | N/A | | | `customMappings` | Record | :heavy_minus_sign: | When custom mappings are configured on the resource, the result is included here. | | | `passThrough` | [components.PassThroughBody](../../models/components/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. | | -| `accountingPeriod` | *string* | :heavy_minus_sign: | Accounting period | 01-24 | \ No newline at end of file +| `accountingPeriod` | *string* | :heavy_minus_sign: | Accounting period | 01-24 | +| `attachments` | [components.LinkedAttachment](../../models/components/linkedattachment.md)[] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/billinput.md b/docs/models/components/billinput.md index 6086a3c2..e16f432a 100644 --- a/docs/models/components/billinput.md +++ b/docs/models/components/billinput.md @@ -7,6 +7,7 @@ import { BillInput } from "@apideck/unify/models/components"; import { RFCDate } from "@apideck/unify/types"; let value: BillInput = { + displayId: "123456", billNumber: "10001", supplier: { id: "12345", @@ -39,6 +40,7 @@ let value: BillInput = { }, }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -66,6 +68,14 @@ let value: BillInput = { departmentId: "12345", subsidiaryId: "12345", categoryId: "12345", + shippingId: "12345", + memo: "Some memo", + prepaid: true, + taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", + taxRecoverability: "Fully_Recoverable", + taxMethod: "Due_to_Supplier", + retentionAmount: 1000, + paymentAmount: 1000, item: { id: "12344", code: "120-C", @@ -105,6 +115,12 @@ let value: BillInput = { linkedTransactionLineId: "line_xyz789", }, rowVersion: "1-12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], }, ], terms: "Net 30 days", @@ -140,6 +156,10 @@ let value: BillInput = { country: "US", }, discountPercentage: 5.5, + templateId: "123456", + approvedBy: "John Doe", + taxMethod: "Due to supplier", + documentReceived: true, sourceDocumentUrl: "https://www.invoicesolution.com/bill/123456", trackingCategories: [ { @@ -174,6 +194,16 @@ let value: BillInput = { }, ], accountingPeriod: "01-24", + attachments: [ + { + name: "sample.jpg", + mimeType: "image/jpeg", + isCompressed: false, + encoding: "base64", + content: "data:image/jpeg;base64,...", + notes: "A sample image", + }, + ], }; ``` @@ -181,9 +211,11 @@ let value: BillInput = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `displayId` | *string* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `billNumber` | *string* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | | `supplier` | [components.LinkedSupplierInput](../../models/components/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `currency` | [components.Currency](../../models/components/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 | | `currencyRate` | *number* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `taxInclusive` | *boolean* | :heavy_minus_sign: | Amounts are including tax | true | @@ -209,9 +241,15 @@ let value: BillInput = { | `accountingByRow` | *boolean* | :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 | | `bankAccount` | [components.BankAccount](../../models/components/bankaccount.md) | :heavy_minus_sign: | N/A | | | `discountPercentage` | *number* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 | +| `templateId` | *string* | :heavy_minus_sign: | Optional bill template | 123456 | +| `approvedBy` | *string* | :heavy_minus_sign: | The user who approved the bill | John Doe | +| `amortizationType` | [components.AmortizationType](../../models/components/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | +| `documentReceived` | *boolean* | :heavy_minus_sign: | Whether the document has been received | true | | `sourceDocumentUrl` | *string* | :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 | | `trackingCategories` | [components.LinkedTrackingCategory](../../models/components/linkedtrackingcategory.md)[] | :heavy_minus_sign: | A list of linked tracking categories. | | | `rowVersion` | *string* | :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 | | `customFields` | [components.CustomField](../../models/components/customfield.md)[] | :heavy_minus_sign: | N/A | | | `passThrough` | [components.PassThroughBody](../../models/components/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. | | -| `accountingPeriod` | *string* | :heavy_minus_sign: | Accounting period | 01-24 | \ No newline at end of file +| `accountingPeriod` | *string* | :heavy_minus_sign: | Accounting period | 01-24 | +| `attachments` | [components.LinkedAttachment](../../models/components/linkedattachment.md)[] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/billlineitem.md b/docs/models/components/billlineitem.md index a3c4a1f1..5d594347 100644 --- a/docs/models/components/billlineitem.md +++ b/docs/models/components/billlineitem.md @@ -24,6 +24,14 @@ let value: BillLineItem = { departmentId: "12345", subsidiaryId: "12345", categoryId: "12345", + shippingId: "12345", + memo: "Some memo", + prepaid: true, + taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", + taxRecoverability: "Fully_Recoverable", + taxMethod: "Due_to_Supplier", + retentionAmount: 1000, + paymentAmount: 1000, item: { id: "12344", code: "120-C", @@ -72,6 +80,12 @@ let value: BillLineItem = { createdBy: "12345", createdAt: new Date("2020-09-30T07:43:32.000Z"), updatedAt: new Date("2020-09-30T07:43:32.000Z"), + worktags: [ + { + id: "123456", + value: "New York", + }, + ], }; ``` @@ -96,6 +110,14 @@ let value: BillLineItem = { | `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `subsidiaryId` | *string* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | | `categoryId` | *string* | :heavy_minus_sign: | ID of the category of the line item | 12345 | +| `shippingId` | *string* | :heavy_minus_sign: | ID of the shipping of the line item | 12345 | +| `memo` | *string* | :heavy_minus_sign: | Memo | Some memo | +| `prepaid` | *boolean* | :heavy_minus_sign: | Whether the line item is prepaid | true | +| `taxApplicableOn` | *string* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | +| `taxRecoverability` | *string* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | +| `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | +| `retentionAmount` | *number* | :heavy_minus_sign: | Retention amount | 1000 | +| `paymentAmount` | *number* | :heavy_minus_sign: | Payment amount | 1000 | | `item` | [components.LinkedInvoiceItem](../../models/components/linkedinvoiceitem.md) | :heavy_minus_sign: | N/A | | | `taxRate` | [components.LinkedTaxRate](../../models/components/linkedtaxrate.md) | :heavy_minus_sign: | N/A | | | `ledgerAccount` | [components.LinkedLedgerAccount](../../models/components/linkedledgeraccount.md) | :heavy_minus_sign: | N/A | | @@ -107,4 +129,5 @@ let value: BillLineItem = { | `updatedBy` | *string* | :heavy_minus_sign: | The user who last updated the object. | 12345 | | `createdBy` | *string* | :heavy_minus_sign: | The user who created the object. | 12345 | | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time when the object was created. | 2020-09-30T07:43:32.000Z | -| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :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 +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time when the object was last updated. | 2020-09-30T07:43:32.000Z | +| `worktags` | [components.LinkedWorktag](../../models/components/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/components/billlineiteminput.md b/docs/models/components/billlineiteminput.md index e8eedf54..70156a05 100644 --- a/docs/models/components/billlineiteminput.md +++ b/docs/models/components/billlineiteminput.md @@ -23,6 +23,14 @@ let value: BillLineItemInput = { departmentId: "12345", subsidiaryId: "12345", categoryId: "12345", + shippingId: "12345", + memo: "Some memo", + prepaid: true, + taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", + taxRecoverability: "Fully_Recoverable", + taxMethod: "Due_to_Supplier", + retentionAmount: 1000, + paymentAmount: 1000, item: { id: "12344", code: "120-C", @@ -55,6 +63,12 @@ let value: BillLineItemInput = { linkedTransactionLineId: "line_xyz789", }, rowVersion: "1-12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], }; ``` @@ -78,6 +92,14 @@ let value: BillLineItemInput = { | `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `subsidiaryId` | *string* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | | `categoryId` | *string* | :heavy_minus_sign: | ID of the category of the line item | 12345 | +| `shippingId` | *string* | :heavy_minus_sign: | ID of the shipping of the line item | 12345 | +| `memo` | *string* | :heavy_minus_sign: | Memo | Some memo | +| `prepaid` | *boolean* | :heavy_minus_sign: | Whether the line item is prepaid | true | +| `taxApplicableOn` | *string* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | +| `taxRecoverability` | *string* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | +| `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | +| `retentionAmount` | *number* | :heavy_minus_sign: | Retention amount | 1000 | +| `paymentAmount` | *number* | :heavy_minus_sign: | Payment amount | 1000 | | `item` | [components.LinkedInvoiceItem](../../models/components/linkedinvoiceitem.md) | :heavy_minus_sign: | N/A | | | `taxRate` | [components.LinkedTaxRateInput](../../models/components/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | | | `ledgerAccount` | [components.LinkedLedgerAccountInput](../../models/components/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | @@ -85,4 +107,5 @@ let value: BillLineItemInput = { | `trackingCategories` | [components.LinkedTrackingCategory](../../models/components/linkedtrackingcategory.md)[] | :heavy_minus_sign: | A list of linked tracking categories. | | | `customer` | [components.LinkedCustomerInput](../../models/components/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `rebilling` | [components.Rebilling](../../models/components/rebilling.md) | :heavy_minus_sign: | Rebilling metadata for this line item. | | -| `rowVersion` | *string* | :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 +| `rowVersion` | *string* | :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` | [components.LinkedWorktag](../../models/components/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/components/billpayment.md b/docs/models/components/billpayment.md index af021a0e..0d3a1260 100644 --- a/docs/models/components/billpayment.md +++ b/docs/models/components/billpayment.md @@ -94,7 +94,7 @@ let value: BillPayment = { | `account` | [components.LinkedLedgerAccount](../../models/components/linkedledgeraccount.md) | :heavy_minus_sign: | N/A | | | `transactionDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `supplier` | [components.LinkedSupplier](../../models/components/linkedsupplier.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *boolean* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [components.PaymentStatus](../../models/components/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [components.BillPaymentType](../../models/components/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable | diff --git a/docs/models/components/billpaymentinput.md b/docs/models/components/billpaymentinput.md index c794e873..0a452fbd 100644 --- a/docs/models/components/billpaymentinput.md +++ b/docs/models/components/billpaymentinput.md @@ -113,7 +113,7 @@ let value: BillPaymentInput = { | `account` | [components.LinkedLedgerAccountInput](../../models/components/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | | `transactionDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `supplier` | [components.LinkedSupplierInput](../../models/components/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *boolean* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [components.PaymentStatus](../../models/components/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [components.BillPaymentType](../../models/components/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable | diff --git a/docs/models/components/budget.md b/docs/models/components/budget.md deleted file mode 100644 index 59f85c1e..00000000 --- a/docs/models/components/budget.md +++ /dev/null @@ -1,17 +0,0 @@ -# Budget - -Budget of the line item - -## Example Usage - -```typescript -import { Budget } from "@apideck/unify/models/components"; - -let value: Budget = "in_budget"; -``` - -## Values - -```typescript -"out_of_budget" | "in_budget" | "other" -``` \ No newline at end of file diff --git a/docs/models/components/configuration.md b/docs/models/components/configuration.md index b64c92de..dfbed027 100644 --- a/docs/models/components/configuration.md +++ b/docs/models/components/configuration.md @@ -14,7 +14,14 @@ let value: Configuration = { options: [ { label: "General Channel", - optionType: "simple", + options: [ + { + label: "General Channel", + value: "general", + optionType: "simple", + }, + ], + optionType: "group", }, ], value: "GC5000 series", diff --git a/docs/models/components/connection.md b/docs/models/components/connection.md index 1e2a370b..f5ef8b9e 100644 --- a/docs/models/components/connection.md +++ b/docs/models/components/connection.md @@ -69,7 +69,14 @@ let value: Connection = { options: [ { label: "General Channel", - optionType: "simple", + options: [ + { + label: "General Channel", + value: "general", + optionType: "simple", + }, + ], + optionType: "group", }, ], value: "GC5000 series", diff --git a/docs/models/components/connectionconfiguration.md b/docs/models/components/connectionconfiguration.md index 2b0432e6..2d4692cd 100644 --- a/docs/models/components/connectionconfiguration.md +++ b/docs/models/components/connectionconfiguration.md @@ -13,14 +13,7 @@ let value: ConnectionConfiguration = { options: [ { label: "General Channel", - options: [ - { - label: "General Channel", - value: "general", - optionType: "simple", - }, - ], - optionType: "group", + optionType: "simple", }, ], value: "GC5000 series", diff --git a/docs/models/components/connectioninput.md b/docs/models/components/connectioninput.md index bdbaf724..1a912e04 100644 --- a/docs/models/components/connectioninput.md +++ b/docs/models/components/connectioninput.md @@ -27,14 +27,7 @@ let value: ConnectionInput = { options: [ { label: "General Channel", - options: [ - { - label: "General Channel", - value: "general", - optionType: "simple", - }, - ], - optionType: "group", + optionType: "simple", }, ], value: "GC5000 series", diff --git a/docs/models/components/createconnectionresponse.md b/docs/models/components/createconnectionresponse.md index 90a08e3e..d0ed20c6 100644 --- a/docs/models/components/createconnectionresponse.md +++ b/docs/models/components/createconnectionresponse.md @@ -74,7 +74,14 @@ let value: CreateConnectionResponse = { options: [ { label: "General Channel", - optionType: "simple", + options: [ + { + label: "General Channel", + value: "general", + optionType: "simple", + }, + ], + optionType: "group", }, ], value: "GC5000 series", diff --git a/docs/models/components/creditnote.md b/docs/models/components/creditnote.md index 48bcb04f..2796d37a 100644 --- a/docs/models/components/creditnote.md +++ b/docs/models/components/creditnote.md @@ -16,6 +16,7 @@ let value: CreditNote = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -67,8 +68,12 @@ let value: CreditNote = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", @@ -212,7 +217,8 @@ let value: CreditNote = { | `id` | *string* | :heavy_check_mark: | Unique identifier representing the entity | 123456 | | `number` | *string* | :heavy_minus_sign: | Credit note number. | OIT00546 | | `customer` | [components.LinkedCustomer](../../models/components/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `currency` | [components.Currency](../../models/components/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 | | `currencyRate` | *number* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `taxInclusive` | *boolean* | :heavy_minus_sign: | Amounts are including tax | true | diff --git a/docs/models/components/creditnoteinput.md b/docs/models/components/creditnoteinput.md index 6d273f24..247c041e 100644 --- a/docs/models/components/creditnoteinput.md +++ b/docs/models/components/creditnoteinput.md @@ -13,6 +13,7 @@ let value: CreditNoteInput = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -63,8 +64,12 @@ let value: CreditNoteInput = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, @@ -195,7 +200,8 @@ let value: CreditNoteInput = { | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `number` | *string* | :heavy_minus_sign: | Credit note number. | OIT00546 | | `customer` | [components.LinkedCustomerInput](../../models/components/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `currency` | [components.Currency](../../models/components/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 | | `currencyRate` | *number* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `taxInclusive` | *boolean* | :heavy_minus_sign: | Amounts are including tax | true | diff --git a/docs/models/components/customer.md b/docs/models/components/customer.md index 06fef9ed..b47bd15d 100644 --- a/docs/models/components/customer.md +++ b/docs/models/components/customer.md @@ -146,7 +146,7 @@ let value: Customer = { | `displayId` | *string* | :heavy_minus_sign: | Display ID | EMP00101 | | `displayName` | *string* | :heavy_minus_sign: | Display name | Windsurf Shop | | `companyName` | *string* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `title` | *string* | :heavy_minus_sign: | The job title of the person. | CEO | | `firstName` | *string* | :heavy_minus_sign: | The first name of the person. | Elon | | `middleName` | *string* | :heavy_minus_sign: | Middle name of the person. | D. | diff --git a/docs/models/components/customerinput.md b/docs/models/components/customerinput.md index f1cfa513..820faa03 100644 --- a/docs/models/components/customerinput.md +++ b/docs/models/components/customerinput.md @@ -138,7 +138,7 @@ let value: CustomerInput = { | `displayId` | *string* | :heavy_minus_sign: | Display ID | EMP00101 | | `displayName` | *string* | :heavy_minus_sign: | Display name | Windsurf Shop | | `companyName` | *string* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `title` | *string* | :heavy_minus_sign: | The job title of the person. | CEO | | `firstName` | *string* | :heavy_minus_sign: | The first name of the person. | Elon | | `middleName` | *string* | :heavy_minus_sign: | Middle name of the person. | D. | diff --git a/docs/models/components/defaults.md b/docs/models/components/defaults.md index 0524df90..ecf797ac 100644 --- a/docs/models/components/defaults.md +++ b/docs/models/components/defaults.md @@ -11,7 +11,14 @@ let value: Defaults = { options: [ { label: "General Channel", - optionType: "simple", + options: [ + { + label: "General Channel", + value: "general", + optionType: "simple", + }, + ], + optionType: "group", }, ], value: "GC5000 series", diff --git a/docs/models/components/expense.md b/docs/models/components/expense.md index 86a03f88..c325ab26 100644 --- a/docs/models/components/expense.md +++ b/docs/models/components/expense.md @@ -70,7 +70,7 @@ let value: Expense = { | `accountId` | *string* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 | | `customerId` | *string* | :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 | | `supplierId` | *string* | :heavy_minus_sign: | The ID of the supplier this entity is linked to. | 12345 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `paymentType` | [components.ExpensePaymentType](../../models/components/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash | | `currency` | [components.Currency](../../models/components/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/components/expenseinput.md b/docs/models/components/expenseinput.md index f887e0ee..f5e5535d 100644 --- a/docs/models/components/expenseinput.md +++ b/docs/models/components/expenseinput.md @@ -62,7 +62,7 @@ let value: ExpenseInput = { | `accountId` | *string* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 | | `customerId` | *string* | :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 | | `supplierId` | *string* | :heavy_minus_sign: | The ID of the supplier this entity is linked to. | 12345 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `paymentType` | [components.ExpensePaymentType](../../models/components/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash | | `currency` | [components.Currency](../../models/components/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/components/getapplicantresponse.md b/docs/models/components/getapplicantresponse.md index c3366b3c..4da7f558 100644 --- a/docs/models/components/getapplicantresponse.md +++ b/docs/models/components/getapplicantresponse.md @@ -17,11 +17,15 @@ let value: GetApplicantResponse = { data: { id: "12345", name: "Elon Musk", + salutation: "Mr", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), + gender: "male", + socialSecurityNumber: "123456789", + type: "Candidate", coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", jobUrl: "https://democompany.recruitee.com/o/example-talent-pool", diff --git a/docs/models/components/getbillresponse.md b/docs/models/components/getbillresponse.md index ffa50db3..f67f1ef5 100644 --- a/docs/models/components/getbillresponse.md +++ b/docs/models/components/getbillresponse.md @@ -17,6 +17,7 @@ let value: GetBillResponse = { data: { id: "12345", downstreamId: "12345", + displayId: "123456", billNumber: "10001", supplier: { id: "12345", @@ -51,6 +52,7 @@ let value: GetBillResponse = { }, }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -79,6 +81,14 @@ let value: GetBillResponse = { departmentId: "12345", subsidiaryId: "12345", categoryId: "12345", + shippingId: "12345", + memo: "Some memo", + prepaid: true, + taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", + taxRecoverability: "Fully_Recoverable", + taxMethod: "Due_to_Supplier", + retentionAmount: 1000, + paymentAmount: 1000, item: { id: "12344", code: "120-C", @@ -122,6 +132,12 @@ let value: GetBillResponse = { createdBy: "12345", createdAt: new Date("2020-09-30T07:43:32.000Z"), updatedAt: new Date("2020-09-30T07:43:32.000Z"), + worktags: [ + { + id: "123456", + value: "New York", + }, + ], }, ], terms: "Net 30 days", @@ -158,6 +174,10 @@ let value: GetBillResponse = { country: "US", }, discountPercentage: 5.5, + templateId: "123456", + approvedBy: "John Doe", + taxMethod: "Due to supplier", + documentReceived: true, sourceDocumentUrl: "https://www.invoicesolution.com/bill/123456", trackingCategories: [ { @@ -196,6 +216,16 @@ let value: GetBillResponse = { }, ], accountingPeriod: "01-24", + attachments: [ + { + name: "sample.jpg", + mimeType: "image/jpeg", + isCompressed: false, + encoding: "base64", + content: "data:image/jpeg;base64,...", + notes: "A sample image", + }, + ], }, }; ``` diff --git a/docs/models/components/getconnectionresponse.md b/docs/models/components/getconnectionresponse.md index 17441d9e..a319e0e4 100644 --- a/docs/models/components/getconnectionresponse.md +++ b/docs/models/components/getconnectionresponse.md @@ -74,7 +74,14 @@ let value: GetConnectionResponse = { options: [ { label: "General Channel", - optionType: "simple", + options: [ + { + label: "General Channel", + value: "general", + optionType: "simple", + }, + ], + optionType: "group", }, ], value: "GC5000 series", diff --git a/docs/models/components/getcreditnoteresponse.md b/docs/models/components/getcreditnoteresponse.md index 8c71e9eb..a97fe1c8 100644 --- a/docs/models/components/getcreditnoteresponse.md +++ b/docs/models/components/getcreditnoteresponse.md @@ -24,6 +24,7 @@ let value: GetCreditNoteResponse = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -75,8 +76,12 @@ let value: GetCreditNoteResponse = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", diff --git a/docs/models/components/getcreditnotesresponse.md b/docs/models/components/getcreditnotesresponse.md index 550af260..ae7498ce 100644 --- a/docs/models/components/getcreditnotesresponse.md +++ b/docs/models/components/getcreditnotesresponse.md @@ -25,6 +25,7 @@ let value: GetCreditNotesResponse = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -76,8 +77,12 @@ let value: GetCreditNotesResponse = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", diff --git a/docs/models/components/getinvoiceresponse.md b/docs/models/components/getinvoiceresponse.md index 6493f40a..555ae0b0 100644 --- a/docs/models/components/getinvoiceresponse.md +++ b/docs/models/components/getinvoiceresponse.md @@ -17,6 +17,7 @@ let value: GetInvoiceResponse = { data: { id: "12345", downstreamId: "12345", + displayId: "123456", type: "service", number: "OIT00546", customer: { @@ -27,6 +28,7 @@ let value: GetInvoiceResponse = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", invoiceDate: new RFCDate("2020-09-30"), dueDate: new RFCDate("2020-09-30"), terms: "Net 30 days", @@ -85,8 +87,12 @@ let value: GetInvoiceResponse = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", diff --git a/docs/models/components/getpurchaseorderresponse.md b/docs/models/components/getpurchaseorderresponse.md index 18f23448..d3de7c83 100644 --- a/docs/models/components/getpurchaseorderresponse.md +++ b/docs/models/components/getpurchaseorderresponse.md @@ -53,6 +53,7 @@ let value: GetPurchaseOrderResponse = { }, subsidiaryId: "12345", companyId: "12345", + departmentId: "12345", status: "open", issuedDate: new RFCDate("2020-09-30"), deliveryDate: new RFCDate("2020-09-30"), @@ -94,8 +95,12 @@ let value: GetPurchaseOrderResponse = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", diff --git a/docs/models/components/getpurchaseordersresponse.md b/docs/models/components/getpurchaseordersresponse.md index b5c1ca6c..32260888 100644 --- a/docs/models/components/getpurchaseordersresponse.md +++ b/docs/models/components/getpurchaseordersresponse.md @@ -54,6 +54,7 @@ let value: GetPurchaseOrdersResponse = { }, subsidiaryId: "12345", companyId: "12345", + departmentId: "12345", status: "open", issuedDate: new RFCDate("2020-09-30"), deliveryDate: new RFCDate("2020-09-30"), @@ -95,8 +96,12 @@ let value: GetPurchaseOrdersResponse = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", diff --git a/docs/models/components/getquoteresponse.md b/docs/models/components/getquoteresponse.md index 70a5a7f7..ef5697e1 100644 --- a/docs/models/components/getquoteresponse.md +++ b/docs/models/components/getquoteresponse.md @@ -28,6 +28,7 @@ let value: GetQuoteResponse = { invoiceId: "123456", salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), diff --git a/docs/models/components/getquotesresponse.md b/docs/models/components/getquotesresponse.md index 9c19de70..8539d849 100644 --- a/docs/models/components/getquotesresponse.md +++ b/docs/models/components/getquotesresponse.md @@ -29,6 +29,7 @@ let value: GetQuotesResponse = { invoiceId: "123456", salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), diff --git a/docs/models/components/invoice.md b/docs/models/components/invoice.md index 807b6533..631c7732 100644 --- a/docs/models/components/invoice.md +++ b/docs/models/components/invoice.md @@ -9,6 +9,7 @@ import { RFCDate } from "@apideck/unify/types"; let value: Invoice = { id: "12345", downstreamId: "12345", + displayId: "123456", type: "service", number: "OIT00546", customer: { @@ -19,6 +20,7 @@ let value: Invoice = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", invoiceDate: new RFCDate("2020-09-30"), dueDate: new RFCDate("2020-09-30"), terms: "Net 30 days", @@ -77,8 +79,12 @@ let value: Invoice = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", @@ -236,10 +242,12 @@ let value: Invoice = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `downstreamId` | *string* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | +| `displayId` | *string* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `type` | [components.InvoiceType](../../models/components/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | | `number` | *string* | :heavy_minus_sign: | Invoice number. | OIT00546 | | `customer` | [components.LinkedCustomer](../../models/components/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `invoiceDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date invoice was issued - YYYY-MM-DD. | 2020-09-30 | | `dueDate` | [RFCDate](../../types/rfcdate.md) | :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` | *string* | :heavy_minus_sign: | Terms of payment. | Net 30 days | diff --git a/docs/models/components/invoiceinput.md b/docs/models/components/invoiceinput.md index e7631848..487d6029 100644 --- a/docs/models/components/invoiceinput.md +++ b/docs/models/components/invoiceinput.md @@ -7,6 +7,7 @@ import { InvoiceInput } from "@apideck/unify/models/components"; import { RFCDate } from "@apideck/unify/types"; let value: InvoiceInput = { + displayId: "123456", type: "service", number: "OIT00546", customer: { @@ -15,6 +16,7 @@ let value: InvoiceInput = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", invoiceDate: new RFCDate("2020-09-30"), dueDate: new RFCDate("2020-09-30"), terms: "Net 30 days", @@ -73,8 +75,12 @@ let value: InvoiceInput = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, @@ -218,10 +224,12 @@ let value: InvoiceInput = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `displayId` | *string* | :heavy_minus_sign: | Id to be displayed. | 123456 | | `type` | [components.InvoiceType](../../models/components/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | | `number` | *string* | :heavy_minus_sign: | Invoice number. | OIT00546 | | `customer` | [components.LinkedCustomerInput](../../models/components/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `invoiceDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date invoice was issued - YYYY-MM-DD. | 2020-09-30 | | `dueDate` | [RFCDate](../../types/rfcdate.md) | :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` | *string* | :heavy_minus_sign: | Terms of payment. | Net 30 days | diff --git a/docs/models/components/invoicelineitem.md b/docs/models/components/invoicelineitem.md index 329a95f2..70cc777f 100644 --- a/docs/models/components/invoicelineitem.md +++ b/docs/models/components/invoicelineitem.md @@ -35,8 +35,12 @@ let value: InvoiceLineItem = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", @@ -101,8 +105,7 @@ let value: InvoiceLineItem = { | `taxApplicableOn` | *string* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | | `taxRecoverability` | *string* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | | `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | -| `budget` | [components.Budget](../../models/components/budget.md) | :heavy_minus_sign: | Budget of the line item | in_budget | -| `projectId` | *string* | :heavy_minus_sign: | ID of the project of the line item | 12345 | +| `worktags` | [components.LinkedWorktag](../../models/components/linkedworktag.md)[] | :heavy_minus_sign: | Worktags of the line item. This is currently only supported in Workday. | | | `taxRate` | [components.LinkedTaxRate](../../models/components/linkedtaxrate.md) | :heavy_minus_sign: | N/A | | | `trackingCategories` | [components.LinkedTrackingCategory](../../models/components/linkedtrackingcategory.md)[] | :heavy_minus_sign: | A list of linked tracking categories. | | | `ledgerAccount` | [components.LinkedLedgerAccount](../../models/components/linkedledgeraccount.md) | :heavy_minus_sign: | N/A | | diff --git a/docs/models/components/invoicelineiteminput.md b/docs/models/components/invoicelineiteminput.md index 51892692..a732d1dc 100644 --- a/docs/models/components/invoicelineiteminput.md +++ b/docs/models/components/invoicelineiteminput.md @@ -35,8 +35,12 @@ let value: InvoiceLineItemInput = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, @@ -94,8 +98,7 @@ let value: InvoiceLineItemInput = { | `taxApplicableOn` | *string* | :heavy_minus_sign: | Tax applicable on | Domestic_Purchase_of_Goods_and_Services | | `taxRecoverability` | *string* | :heavy_minus_sign: | Tax recoverability | Fully_Recoverable | | `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due_to_Supplier | -| `budget` | [components.Budget](../../models/components/budget.md) | :heavy_minus_sign: | Budget of the line item | in_budget | -| `projectId` | *string* | :heavy_minus_sign: | ID of the project of the line item | 12345 | +| `worktags` | [components.LinkedWorktag](../../models/components/linkedworktag.md)[] | :heavy_minus_sign: | Worktags of the line item. This is currently only supported in Workday. | | | `taxRate` | [components.LinkedTaxRateInput](../../models/components/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | | | `trackingCategories` | [components.LinkedTrackingCategory](../../models/components/linkedtrackingcategory.md)[] | :heavy_minus_sign: | A list of linked tracking categories. | | | `ledgerAccount` | [components.LinkedLedgerAccountInput](../../models/components/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | | diff --git a/docs/models/components/journalentry.md b/docs/models/components/journalentry.md index 2b752748..6a1b9a70 100644 --- a/docs/models/components/journalentry.md +++ b/docs/models/components/journalentry.md @@ -132,7 +132,7 @@ let value: JournalEntry = { | `title` | *string* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | | `currencyRate` | *number* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `currency` | [components.Currency](../../models/components/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 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `lineItems` | [components.JournalEntryLineItem](../../models/components/journalentrylineitem.md)[] | :heavy_minus_sign: | Requires a minimum of 2 line items that sum to 0 | | | `status` | [components.JournalEntryStatus](../../models/components/journalentrystatus.md) | :heavy_minus_sign: | Journal entry status | draft | | `memo` | *string* | :heavy_minus_sign: | Reference for the journal entry. | Thank you for your business and have a great day! | diff --git a/docs/models/components/journalentryinput.md b/docs/models/components/journalentryinput.md index 2ad2cee2..b8029e7a 100644 --- a/docs/models/components/journalentryinput.md +++ b/docs/models/components/journalentryinput.md @@ -125,7 +125,7 @@ let value: JournalEntryInput = { | `title` | *string* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | | `currencyRate` | *number* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | | `currency` | [components.Currency](../../models/components/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 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `lineItems` | [components.JournalEntryLineItemInput](../../models/components/journalentrylineiteminput.md)[] | :heavy_minus_sign: | Requires a minimum of 2 line items that sum to 0 | | | `status` | [components.JournalEntryStatus](../../models/components/journalentrystatus.md) | :heavy_minus_sign: | Journal entry status | draft | | `memo` | *string* | :heavy_minus_sign: | Reference for the journal entry. | Thank you for your business and have a great day! | diff --git a/docs/models/components/linkedattachment.md b/docs/models/components/linkedattachment.md new file mode 100644 index 00000000..6078ac13 --- /dev/null +++ b/docs/models/components/linkedattachment.md @@ -0,0 +1,27 @@ +# LinkedAttachment + +## Example Usage + +```typescript +import { LinkedAttachment } from "@apideck/unify/models/components"; + +let value: LinkedAttachment = { + name: "sample.jpg", + mimeType: "image/jpeg", + isCompressed: false, + encoding: "base64", + content: "data:image/jpeg;base64,...", + notes: "A sample image", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | +| `name` | *string* | :heavy_minus_sign: | The name of the file | sample.jpg | +| `mimeType` | *string* | :heavy_minus_sign: | The MIME type of the file. | image/jpeg | +| `isCompressed` | *boolean* | :heavy_minus_sign: | Whether the file is c ompressed. | false | +| `encoding` | *string* | :heavy_minus_sign: | The encoding of the file. | base64 | +| `content` | *string* | :heavy_minus_sign: | The content of the file. | data:image/jpeg;base64,... | +| `notes` | *string* | :heavy_minus_sign: | The notes of the file. | A sample image | \ No newline at end of file diff --git a/docs/models/components/linkedworktag.md b/docs/models/components/linkedworktag.md new file mode 100644 index 00000000..07c63c29 --- /dev/null +++ b/docs/models/components/linkedworktag.md @@ -0,0 +1,19 @@ +# LinkedWorktag + +## Example Usage + +```typescript +import { LinkedWorktag } from "@apideck/unify/models/components"; + +let value: LinkedWorktag = { + id: "123456", + value: "New York", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `id` | *string* | :heavy_minus_sign: | The unique identifier for the worktag. | 123456 | +| `value` | *string* | :heavy_minus_sign: | The value of the worktag. | New York | \ No newline at end of file diff --git a/docs/models/components/payment.md b/docs/models/components/payment.md index 3e0fa61d..f65fb72e 100644 --- a/docs/models/components/payment.md +++ b/docs/models/components/payment.md @@ -95,7 +95,7 @@ let value: Payment = { | `transactionDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `customer` | [components.LinkedCustomer](../../models/components/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | ~~`supplier`~~ | [components.DeprecatedLinkedSupplier](../../models/components/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. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *boolean* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [components.PaymentStatus](../../models/components/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [components.PaymentType](../../models/components/paymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable | diff --git a/docs/models/components/paymentinput.md b/docs/models/components/paymentinput.md index 4cc44027..d1c332a1 100644 --- a/docs/models/components/paymentinput.md +++ b/docs/models/components/paymentinput.md @@ -90,7 +90,7 @@ let value: PaymentInput = { | `transactionDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `customer` | [components.LinkedCustomerInput](../../models/components/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | ~~`supplier`~~ | [components.DeprecatedLinkedSupplierInput](../../models/components/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. | | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `reconciled` | *boolean* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true | | `status` | [components.PaymentStatus](../../models/components/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised | | `type` | [components.PaymentType](../../models/components/paymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable | diff --git a/docs/models/components/purchaseorder.md b/docs/models/components/purchaseorder.md index 253b6890..b5d80c37 100644 --- a/docs/models/components/purchaseorder.md +++ b/docs/models/components/purchaseorder.md @@ -45,6 +45,7 @@ let value: PurchaseOrder = { }, subsidiaryId: "12345", companyId: "12345", + departmentId: "12345", status: "open", issuedDate: new RFCDate("2020-09-30"), deliveryDate: new RFCDate("2020-09-30"), @@ -86,8 +87,12 @@ let value: PurchaseOrder = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", code: "N-T", @@ -257,7 +262,8 @@ let value: PurchaseOrder = { | `reference` | *string* | :heavy_minus_sign: | Optional purchase order reference. | 123456 | | `supplier` | [components.LinkedSupplier](../../models/components/linkedsupplier.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `subsidiaryId` | *string* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `status` | [components.PurchaseOrderStatus](../../models/components/purchaseorderstatus.md) | :heavy_minus_sign: | N/A | open | | `issuedDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date purchase order was issued - YYYY-MM-DD. | 2020-09-30 | | `deliveryDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The date on which the purchase order is to be delivered - YYYY-MM-DD. | 2020-09-30 | @@ -279,7 +285,7 @@ let value: PurchaseOrder = { | `dueDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 | | `paymentMethod` | *string* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `terms` | *string* | :heavy_minus_sign: | Terms of payment. | Net 30 days | -| `amortizationType` | [components.AmortizationType](../../models/components/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `amortizationType` | [components.PurchaseOrderAmortizationType](../../models/components/purchaseorderamortizationtype.md) | :heavy_minus_sign: | Type of amortization | | | `taxCode` | *string* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | | `issuedMethod` | *string* | :heavy_minus_sign: | Method of issuance of the purchase order | Email | diff --git a/docs/models/components/purchaseorderamortizationtype.md b/docs/models/components/purchaseorderamortizationtype.md new file mode 100644 index 00000000..748fcad0 --- /dev/null +++ b/docs/models/components/purchaseorderamortizationtype.md @@ -0,0 +1,17 @@ +# PurchaseOrderAmortizationType + +Type of amortization + +## Example Usage + +```typescript +import { PurchaseOrderAmortizationType } from "@apideck/unify/models/components"; + +let value: PurchaseOrderAmortizationType = "manual"; +``` + +## Values + +```typescript +"manual" | "receipt" | "schedule" | "other" +``` \ No newline at end of file diff --git a/docs/models/components/purchaseorderinput.md b/docs/models/components/purchaseorderinput.md index a1380985..ef7fee20 100644 --- a/docs/models/components/purchaseorderinput.md +++ b/docs/models/components/purchaseorderinput.md @@ -41,6 +41,7 @@ let value: PurchaseOrderInput = { }, subsidiaryId: "12345", companyId: "12345", + departmentId: "12345", status: "open", issuedDate: new RFCDate("2020-09-30"), deliveryDate: new RFCDate("2020-09-30"), @@ -82,8 +83,12 @@ let value: PurchaseOrderInput = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, @@ -239,7 +244,8 @@ let value: PurchaseOrderInput = { | `reference` | *string* | :heavy_minus_sign: | Optional purchase order reference. | 123456 | | `supplier` | [components.LinkedSupplierInput](../../models/components/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | | `subsidiaryId` | *string* | :heavy_minus_sign: | The ID of the subsidiary | 12345 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `status` | [components.PurchaseOrderStatus](../../models/components/purchaseorderstatus.md) | :heavy_minus_sign: | N/A | open | | `issuedDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date purchase order was issued - YYYY-MM-DD. | 2020-09-30 | | `deliveryDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The date on which the purchase order is to be delivered - YYYY-MM-DD. | 2020-09-30 | @@ -261,7 +267,7 @@ let value: PurchaseOrderInput = { | `dueDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 | | `paymentMethod` | *string* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash | | `terms` | *string* | :heavy_minus_sign: | Terms of payment. | Net 30 days | -| `amortizationType` | [components.AmortizationType](../../models/components/amortizationtype.md) | :heavy_minus_sign: | Type of amortization | | +| `amortizationType` | [components.PurchaseOrderAmortizationType](../../models/components/purchaseorderamortizationtype.md) | :heavy_minus_sign: | Type of amortization | | | `taxCode` | *string* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 | | `taxMethod` | *string* | :heavy_minus_sign: | Method of tax calculation | Due to supplier | | `issuedMethod` | *string* | :heavy_minus_sign: | Method of issuance of the purchase order | Email | diff --git a/docs/models/components/quote.md b/docs/models/components/quote.md index e4988681..c8cce28d 100644 --- a/docs/models/components/quote.md +++ b/docs/models/components/quote.md @@ -20,6 +20,7 @@ let value: Quote = { invoiceId: "123456", salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), @@ -198,7 +199,8 @@ let value: Quote = { | `customer` | [components.LinkedCustomer](../../models/components/linkedcustomer.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `invoiceId` | *string* | :heavy_minus_sign: | The unique identifier for the invoice. | 123456 | | `salesOrderId` | *string* | :heavy_minus_sign: | The unique identifier for the sales order. | 123456 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `projectId` | *string* | :heavy_minus_sign: | The unique identifier for the linked project. | 12345 | | `quoteDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date quote was issued - YYYY-MM-DD. | 2020-09-30 | | `expiryDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The date until which the quote is valid - YYYY-MM-DD. | 2020-10-30 | diff --git a/docs/models/components/quoteinput.md b/docs/models/components/quoteinput.md index 934b7ace..d4e6444f 100644 --- a/docs/models/components/quoteinput.md +++ b/docs/models/components/quoteinput.md @@ -15,6 +15,7 @@ let value: QuoteInput = { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), @@ -179,7 +180,8 @@ let value: QuoteInput = { | `number` | *string* | :heavy_minus_sign: | Quote number. | QT00546 | | `customer` | [components.LinkedCustomerInput](../../models/components/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | | `salesOrderId` | *string* | :heavy_minus_sign: | The unique identifier for the sales order. | 123456 | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | +| `departmentId` | *string* | :heavy_minus_sign: | The ID of the department | 12345 | | `projectId` | *string* | :heavy_minus_sign: | The unique identifier for the linked project. | 12345 | | `quoteDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date quote was issued - YYYY-MM-DD. | 2020-09-30 | | `expiryDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | The date until which the quote is valid - YYYY-MM-DD. | 2020-10-30 | diff --git a/docs/models/components/supplier.md b/docs/models/components/supplier.md index 6228819a..79ec1166 100644 --- a/docs/models/components/supplier.md +++ b/docs/models/components/supplier.md @@ -147,7 +147,7 @@ let value: Supplier = { | `displayId` | *string* | :heavy_minus_sign: | Display ID | EMP00101 | | `displayName` | *string* | :heavy_minus_sign: | Display name | Windsurf Shop | | `companyName` | *string* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `supplierCategory` | *string* | :heavy_minus_sign: | The category/type of the supplier | Insurance | | `title` | *string* | :heavy_minus_sign: | The job title of the person. | CEO | | `firstName` | *string* | :heavy_minus_sign: | The first name of the person. | Elon | diff --git a/docs/models/components/supplierinput.md b/docs/models/components/supplierinput.md index 801d049f..f117d40b 100644 --- a/docs/models/components/supplierinput.md +++ b/docs/models/components/supplierinput.md @@ -136,7 +136,7 @@ let value: SupplierInput = { | `displayId` | *string* | :heavy_minus_sign: | Display ID | EMP00101 | | `displayName` | *string* | :heavy_minus_sign: | Display name | Windsurf Shop | | `companyName` | *string* | :heavy_minus_sign: | The name of the company. | SpaceX | -| `companyId` | *string* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 | +| `companyId` | *string* | :heavy_minus_sign: | The company ID the transaction belongs to | 12345 | | `supplierCategory` | *string* | :heavy_minus_sign: | The category/type of the supplier | Insurance | | `title` | *string* | :heavy_minus_sign: | The job title of the person. | CEO | | `firstName` | *string* | :heavy_minus_sign: | The first name of the person. | Elon | diff --git a/docs/models/components/updateconnectionresponse.md b/docs/models/components/updateconnectionresponse.md index 2de9e975..e869053b 100644 --- a/docs/models/components/updateconnectionresponse.md +++ b/docs/models/components/updateconnectionresponse.md @@ -74,7 +74,14 @@ let value: UpdateConnectionResponse = { options: [ { label: "General Channel", - optionType: "simple", + options: [ + { + label: "General Channel", + value: "general", + optionType: "simple", + }, + ], + optionType: "group", }, ], value: "GC5000 series", diff --git a/docs/models/operations/accountingbillsaddrequest.md b/docs/models/operations/accountingbillsaddrequest.md index 2fc18691..ef2ef31e 100644 --- a/docs/models/operations/accountingbillsaddrequest.md +++ b/docs/models/operations/accountingbillsaddrequest.md @@ -9,6 +9,7 @@ import { RFCDate } from "@apideck/unify/types"; let value: AccountingBillsAddRequest = { serviceId: "salesforce", bill: { + displayId: "123456", billNumber: "10001", supplier: { id: "12345", @@ -41,6 +42,7 @@ let value: AccountingBillsAddRequest = { }, }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -68,6 +70,14 @@ let value: AccountingBillsAddRequest = { departmentId: "12345", subsidiaryId: "12345", categoryId: "12345", + shippingId: "12345", + memo: "Some memo", + prepaid: true, + taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", + taxRecoverability: "Fully_Recoverable", + taxMethod: "Due_to_Supplier", + retentionAmount: 1000, + paymentAmount: 1000, item: { id: "12344", code: "120-C", @@ -107,6 +117,12 @@ let value: AccountingBillsAddRequest = { linkedTransactionLineId: "line_xyz789", }, rowVersion: "1-12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], }, ], terms: "Net 30 days", @@ -142,6 +158,10 @@ let value: AccountingBillsAddRequest = { country: "US", }, discountPercentage: 5.5, + templateId: "123456", + approvedBy: "John Doe", + taxMethod: "Due to supplier", + documentReceived: true, sourceDocumentUrl: "https://www.invoicesolution.com/bill/123456", trackingCategories: [ { @@ -176,6 +196,16 @@ let value: AccountingBillsAddRequest = { }, ], accountingPeriod: "01-24", + attachments: [ + { + name: "sample.jpg", + mimeType: "image/jpeg", + isCompressed: false, + encoding: "base64", + content: "data:image/jpeg;base64,...", + notes: "A sample image", + }, + ], }, }; ``` diff --git a/docs/models/operations/accountingbillsupdaterequest.md b/docs/models/operations/accountingbillsupdaterequest.md index 31458aa5..8c486c29 100644 --- a/docs/models/operations/accountingbillsupdaterequest.md +++ b/docs/models/operations/accountingbillsupdaterequest.md @@ -10,6 +10,7 @@ let value: AccountingBillsUpdateRequest = { id: "", serviceId: "salesforce", bill: { + displayId: "123456", billNumber: "10001", supplier: { id: "12345", @@ -42,6 +43,7 @@ let value: AccountingBillsUpdateRequest = { }, }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -69,6 +71,14 @@ let value: AccountingBillsUpdateRequest = { departmentId: "12345", subsidiaryId: "12345", categoryId: "12345", + shippingId: "12345", + memo: "Some memo", + prepaid: true, + taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", + taxRecoverability: "Fully_Recoverable", + taxMethod: "Due_to_Supplier", + retentionAmount: 1000, + paymentAmount: 1000, item: { id: "12344", code: "120-C", @@ -108,6 +118,12 @@ let value: AccountingBillsUpdateRequest = { linkedTransactionLineId: "line_xyz789", }, rowVersion: "1-12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], }, ], terms: "Net 30 days", @@ -143,6 +159,10 @@ let value: AccountingBillsUpdateRequest = { country: "US", }, discountPercentage: 5.5, + templateId: "123456", + approvedBy: "John Doe", + taxMethod: "Due to supplier", + documentReceived: true, sourceDocumentUrl: "https://www.invoicesolution.com/bill/123456", trackingCategories: [ { @@ -177,6 +197,16 @@ let value: AccountingBillsUpdateRequest = { }, ], accountingPeriod: "01-24", + attachments: [ + { + name: "sample.jpg", + mimeType: "image/jpeg", + isCompressed: false, + encoding: "base64", + content: "data:image/jpeg;base64,...", + notes: "A sample image", + }, + ], }, }; ``` diff --git a/docs/models/operations/accountingcreditnotesaddrequest.md b/docs/models/operations/accountingcreditnotesaddrequest.md index f9ea2c20..7ccbbb35 100644 --- a/docs/models/operations/accountingcreditnotesaddrequest.md +++ b/docs/models/operations/accountingcreditnotesaddrequest.md @@ -15,6 +15,7 @@ let value: AccountingCreditNotesAddRequest = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -65,8 +66,12 @@ let value: AccountingCreditNotesAddRequest = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, diff --git a/docs/models/operations/accountingcreditnotesupdaterequest.md b/docs/models/operations/accountingcreditnotesupdaterequest.md index 4c02897f..f977c147 100644 --- a/docs/models/operations/accountingcreditnotesupdaterequest.md +++ b/docs/models/operations/accountingcreditnotesupdaterequest.md @@ -16,6 +16,7 @@ let value: AccountingCreditNotesUpdateRequest = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, @@ -66,8 +67,12 @@ let value: AccountingCreditNotesUpdateRequest = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, diff --git a/docs/models/operations/accountinginvoicesaddrequest.md b/docs/models/operations/accountinginvoicesaddrequest.md index f64e82db..21f2b56b 100644 --- a/docs/models/operations/accountinginvoicesaddrequest.md +++ b/docs/models/operations/accountinginvoicesaddrequest.md @@ -9,6 +9,7 @@ import { RFCDate } from "@apideck/unify/types"; let value: AccountingInvoicesAddRequest = { serviceId: "salesforce", invoice: { + displayId: "123456", type: "service", number: "OIT00546", customer: { @@ -17,6 +18,7 @@ let value: AccountingInvoicesAddRequest = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", invoiceDate: new RFCDate("2020-09-30"), dueDate: new RFCDate("2020-09-30"), terms: "Net 30 days", @@ -68,8 +70,12 @@ let value: AccountingInvoicesAddRequest = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, diff --git a/docs/models/operations/accountinginvoicesupdaterequest.md b/docs/models/operations/accountinginvoicesupdaterequest.md index 93e0301b..4e35c515 100644 --- a/docs/models/operations/accountinginvoicesupdaterequest.md +++ b/docs/models/operations/accountinginvoicesupdaterequest.md @@ -10,6 +10,7 @@ let value: AccountingInvoicesUpdateRequest = { id: "", serviceId: "salesforce", invoice: { + displayId: "123456", type: "service", number: "OIT00546", customer: { @@ -18,6 +19,7 @@ let value: AccountingInvoicesUpdateRequest = { email: "boring@boring.com", }, companyId: "12345", + departmentId: "12345", invoiceDate: new RFCDate("2020-09-30"), dueDate: new RFCDate("2020-09-30"), terms: "Net 30 days", @@ -69,8 +71,12 @@ let value: AccountingInvoicesUpdateRequest = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, diff --git a/docs/models/operations/accountingpurchaseordersaddrequest.md b/docs/models/operations/accountingpurchaseordersaddrequest.md index 7cf1e754..ab92a395 100644 --- a/docs/models/operations/accountingpurchaseordersaddrequest.md +++ b/docs/models/operations/accountingpurchaseordersaddrequest.md @@ -14,6 +14,7 @@ let value: AccountingPurchaseOrdersAddRequest = { supplier: null, subsidiaryId: "12345", companyId: "12345", + departmentId: "12345", status: "open", issuedDate: new RFCDate("2020-09-30"), deliveryDate: new RFCDate("2020-09-30"), @@ -55,8 +56,12 @@ let value: AccountingPurchaseOrdersAddRequest = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, diff --git a/docs/models/operations/accountingpurchaseordersupdaterequest.md b/docs/models/operations/accountingpurchaseordersupdaterequest.md index 54b5e889..90923518 100644 --- a/docs/models/operations/accountingpurchaseordersupdaterequest.md +++ b/docs/models/operations/accountingpurchaseordersupdaterequest.md @@ -15,6 +15,7 @@ let value: AccountingPurchaseOrdersUpdateRequest = { supplier: null, subsidiaryId: "12345", companyId: "12345", + departmentId: "12345", status: "open", issuedDate: new RFCDate("2020-09-30"), deliveryDate: new RFCDate("2020-09-30"), @@ -56,8 +57,12 @@ let value: AccountingPurchaseOrdersUpdateRequest = { taxApplicableOn: "Domestic_Purchase_of_Goods_and_Services", taxRecoverability: "Fully_Recoverable", taxMethod: "Due_to_Supplier", - budget: "in_budget", - projectId: "12345", + worktags: [ + { + id: "123456", + value: "New York", + }, + ], taxRate: { id: "123456", rate: 10, diff --git a/docs/models/operations/accountingquotesaddrequest.md b/docs/models/operations/accountingquotesaddrequest.md index 78343b41..b05d1973 100644 --- a/docs/models/operations/accountingquotesaddrequest.md +++ b/docs/models/operations/accountingquotesaddrequest.md @@ -17,6 +17,7 @@ let value: AccountingQuotesAddRequest = { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), diff --git a/docs/models/operations/accountingquotesupdaterequest.md b/docs/models/operations/accountingquotesupdaterequest.md index a21acaa0..85631ca4 100644 --- a/docs/models/operations/accountingquotesupdaterequest.md +++ b/docs/models/operations/accountingquotesupdaterequest.md @@ -18,6 +18,7 @@ let value: AccountingQuotesUpdateRequest = { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), diff --git a/docs/models/operations/atsapplicantsaddrequest.md b/docs/models/operations/atsapplicantsaddrequest.md index 414b520d..2cd484c1 100644 --- a/docs/models/operations/atsapplicantsaddrequest.md +++ b/docs/models/operations/atsapplicantsaddrequest.md @@ -10,11 +10,15 @@ let value: AtsApplicantsAddRequest = { serviceId: "salesforce", applicant: { name: "Elon Musk", + salutation: "Mr", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), + gender: "male", + socialSecurityNumber: "123456789", + type: "Candidate", coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photoUrl: "https://unavatar.io/elon-musk", diff --git a/docs/models/operations/atsapplicantsupdaterequest.md b/docs/models/operations/atsapplicantsupdaterequest.md index a9cfba1e..5d5dd6f6 100644 --- a/docs/models/operations/atsapplicantsupdaterequest.md +++ b/docs/models/operations/atsapplicantsupdaterequest.md @@ -11,11 +11,15 @@ let value: AtsApplicantsUpdateRequest = { serviceId: "salesforce", applicant: { name: "Elon Musk", + salutation: "Mr", firstName: "Elon", lastName: "Musk", middleName: "D.", initials: "EM", birthday: new RFCDate("2000-08-12"), + gender: "male", + socialSecurityNumber: "123456789", + type: "Candidate", coverLetter: "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photoUrl: "https://unavatar.io/elon-musk", diff --git a/docs/models/operations/vaultconnectionsettingsupdaterequest.md b/docs/models/operations/vaultconnectionsettingsupdaterequest.md index cb78ead1..08ed88e9 100644 --- a/docs/models/operations/vaultconnectionsettingsupdaterequest.md +++ b/docs/models/operations/vaultconnectionsettingsupdaterequest.md @@ -31,14 +31,7 @@ let value: VaultConnectionSettingsUpdateRequest = { options: [ { label: "General Channel", - options: [ - { - label: "General Channel", - value: "general", - optionType: "simple", - }, - ], - optionType: "group", + optionType: "simple", }, ], value: "GC5000 series", diff --git a/docs/models/operations/vaultconnectionsupdaterequest.md b/docs/models/operations/vaultconnectionsupdaterequest.md index ceda81cd..8e3cbf5a 100644 --- a/docs/models/operations/vaultconnectionsupdaterequest.md +++ b/docs/models/operations/vaultconnectionsupdaterequest.md @@ -30,14 +30,7 @@ let value: VaultConnectionsUpdateRequest = { options: [ { label: "General Channel", - options: [ - { - label: "General Channel", - value: "general", - optionType: "simple", - }, - ], - optionType: "group", + optionType: "simple", }, ], value: "GC5000 series", diff --git a/docs/sdks/quotes/README.md b/docs/sdks/quotes/README.md index 83b9e3af..1407f807 100644 --- a/docs/sdks/quotes/README.md +++ b/docs/sdks/quotes/README.md @@ -126,6 +126,7 @@ async function run() { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), @@ -317,6 +318,7 @@ async function run() { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), @@ -621,6 +623,7 @@ async function run() { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), @@ -806,6 +809,7 @@ async function run() { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), diff --git a/examples/accountingTaxRatesList.example.ts b/examples/accountingTaxRatesList.example.ts index cf4f0be1..5fb157a7 100644 --- a/examples/accountingTaxRatesList.example.ts +++ b/examples/accountingTaxRatesList.example.ts @@ -8,7 +8,7 @@ dotenv.config(); * Example usage of the @apideck/unify SDK * * To run this example from the examples directory: - * npm run build && npx tsx accountingTaxRatesList.ts + * npm run build && npx tsx accountingTaxRatesList.example.ts */ import { Apideck } from "@apideck/unify"; diff --git a/examples/package-lock.json b/examples/package-lock.json index 464c5ddc..fcc54e93 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "@apideck/unify", - "version": "0.29.2", + "version": "0.29.3", "dependencies": { "zod": "^3.20.0" }, diff --git a/jsr.json b/jsr.json index 1f30e0cd..82118acc 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@apideck/unify", - "version": "0.29.2", + "version": "0.29.3", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 94cbd606..ae7acdf9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@apideck/unify", - "version": "0.29.2", + "version": "0.29.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@apideck/unify", - "version": "0.29.2", + "version": "0.29.3", "dependencies": { "zod": "^3.20.0" }, diff --git a/package.json b/package.json index 79e45997..24bb6c66 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@apideck/unify", - "version": "0.29.2", + "version": "0.29.3", "author": "Speakeasy", "main": "./index.js", "sideEffects": false, diff --git a/src/__tests__/mockserver/internal/handler/pathgetaccountingquotesid.go b/src/__tests__/mockserver/internal/handler/pathgetaccountingquotesid.go index db42ee94..6d7d2ad4 100644 --- a/src/__tests__/mockserver/internal/handler/pathgetaccountingquotesid.go +++ b/src/__tests__/mockserver/internal/handler/pathgetaccountingquotesid.go @@ -66,6 +66,7 @@ func testAccountingQuotesOneAccountingQuotesOne0(w http.ResponseWriter, req *htt InvoiceID: types.String("123456"), SalesOrderID: types.String("123456"), CompanyID: types.String("12345"), + DepartmentID: types.String("12345"), ProjectID: types.String("12345"), QuoteDate: types.MustNewDateFromString("2020-09-30"), ExpiryDate: types.MustNewDateFromString("2020-10-30"), diff --git a/src/__tests__/mockserver/internal/sdk/models/components/applicant.go b/src/__tests__/mockserver/internal/sdk/models/components/applicant.go index df7d02aa..c7ab9b4e 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/applicant.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/applicant.go @@ -10,6 +10,42 @@ import ( "time" ) +// ApplicantGender - The gender represents the gender identity of a person. +type ApplicantGender string + +const ( + ApplicantGenderMale ApplicantGender = "male" + ApplicantGenderFemale ApplicantGender = "female" + ApplicantGenderUnisex ApplicantGender = "unisex" + ApplicantGenderOther ApplicantGender = "other" + ApplicantGenderNotSpecified ApplicantGender = "not_specified" +) + +func (e ApplicantGender) ToPointer() *ApplicantGender { + return &e +} +func (e *ApplicantGender) UnmarshalJSON(data []byte) error { + var v string + if err := json.Unmarshal(data, &v); err != nil { + return err + } + switch v { + case "male": + fallthrough + case "female": + fallthrough + case "unisex": + fallthrough + case "other": + fallthrough + case "not_specified": + *e = ApplicantGender(v) + return nil + default: + return fmt.Errorf("invalid value for ApplicantGender: %v", v) + } +} + // ApplicantType - The type of website type ApplicantType string @@ -111,6 +147,8 @@ type Applicant struct { ID *string `json:"id,omitempty"` // The name of an applicant. Name *string `json:"name,omitempty"` + // A formal salutation for the person. For example, 'Mr', 'Mrs' + Salutation *string `json:"salutation,omitempty"` // The first name of the person. FirstName *string `json:"first_name,omitempty"` // The last name of the person. @@ -120,9 +158,14 @@ type Applicant struct { // The initials of the person, usually derived from their first, middle, and last names. Initials *string `json:"initials,omitempty"` // The date of birth of the person. - Birthday *types.Date `json:"birthday,omitempty"` - CoverLetter *string `json:"cover_letter,omitempty"` - JobURL *string `json:"job_url,omitempty"` + Birthday *types.Date `json:"birthday,omitempty"` + // The gender represents the gender identity of a person. + Gender *ApplicantGender `json:"gender,omitempty"` + // A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + SocialSecurityNumber *string `json:"social_security_number,omitempty"` + Type *string `json:"type,omitempty"` + CoverLetter *string `json:"cover_letter,omitempty"` + JobURL *string `json:"job_url,omitempty"` // The URL of the photo of a person. PhotoURL *string `json:"photo_url,omitempty"` // Typically a list of previous companies where the contact has worked or schools that the contact has attended @@ -201,6 +244,13 @@ func (o *Applicant) GetName() *string { return o.Name } +func (o *Applicant) GetSalutation() *string { + if o == nil { + return nil + } + return o.Salutation +} + func (o *Applicant) GetFirstName() *string { if o == nil { return nil @@ -236,6 +286,27 @@ func (o *Applicant) GetBirthday() *types.Date { return o.Birthday } +func (o *Applicant) GetGender() *ApplicantGender { + if o == nil { + return nil + } + return o.Gender +} + +func (o *Applicant) GetSocialSecurityNumber() *string { + if o == nil { + return nil + } + return o.SocialSecurityNumber +} + +func (o *Applicant) GetType() *string { + if o == nil { + return nil + } + return o.Type +} + func (o *Applicant) GetCoverLetter() *string { if o == nil { return nil @@ -505,6 +576,8 @@ func (o *Applicant) GetPassThrough() []PassThroughBody { type ApplicantInput struct { // The name of an applicant. Name *string `json:"name,omitempty"` + // A formal salutation for the person. For example, 'Mr', 'Mrs' + Salutation *string `json:"salutation,omitempty"` // The first name of the person. FirstName *string `json:"first_name,omitempty"` // The last name of the person. @@ -514,8 +587,13 @@ type ApplicantInput struct { // The initials of the person, usually derived from their first, middle, and last names. Initials *string `json:"initials,omitempty"` // The date of birth of the person. - Birthday *types.Date `json:"birthday,omitempty"` - CoverLetter *string `json:"cover_letter,omitempty"` + Birthday *types.Date `json:"birthday,omitempty"` + // The gender represents the gender identity of a person. + Gender *ApplicantGender `json:"gender,omitempty"` + // A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + SocialSecurityNumber *string `json:"social_security_number,omitempty"` + Type *string `json:"type,omitempty"` + CoverLetter *string `json:"cover_letter,omitempty"` // The URL of the photo of a person. PhotoURL *string `json:"photo_url,omitempty"` // Typically a list of previous companies where the contact has worked or schools that the contact has attended @@ -568,6 +646,13 @@ func (o *ApplicantInput) GetName() *string { return o.Name } +func (o *ApplicantInput) GetSalutation() *string { + if o == nil { + return nil + } + return o.Salutation +} + func (o *ApplicantInput) GetFirstName() *string { if o == nil { return nil @@ -603,6 +688,27 @@ func (o *ApplicantInput) GetBirthday() *types.Date { return o.Birthday } +func (o *ApplicantInput) GetGender() *ApplicantGender { + if o == nil { + return nil + } + return o.Gender +} + +func (o *ApplicantInput) GetSocialSecurityNumber() *string { + if o == nil { + return nil + } + return o.SocialSecurityNumber +} + +func (o *ApplicantInput) GetType() *string { + if o == nil { + return nil + } + return o.Type +} + func (o *ApplicantInput) GetCoverLetter() *string { if o == nil { return nil diff --git a/src/__tests__/mockserver/internal/sdk/models/components/bill.go b/src/__tests__/mockserver/internal/sdk/models/components/bill.go index 0e6012d2..1f005c2c 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/bill.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/bill.go @@ -55,17 +55,54 @@ func (e *BillStatus) UnmarshalJSON(data []byte) error { } } +// BillAmortizationType - Type of amortization +type BillAmortizationType string + +const ( + BillAmortizationTypeManual BillAmortizationType = "manual" + BillAmortizationTypeReceipt BillAmortizationType = "receipt" + BillAmortizationTypeSchedule BillAmortizationType = "schedule" + BillAmortizationTypeOther BillAmortizationType = "other" +) + +func (e BillAmortizationType) ToPointer() *BillAmortizationType { + return &e +} +func (e *BillAmortizationType) UnmarshalJSON(data []byte) error { + var v string + if err := json.Unmarshal(data, &v); err != nil { + return err + } + switch v { + case "manual": + fallthrough + case "receipt": + fallthrough + case "schedule": + fallthrough + case "other": + *e = BillAmortizationType(v) + return nil + default: + return fmt.Errorf("invalid value for BillAmortizationType: %v", v) + } +} + type Bill struct { // A unique identifier for an object. ID *string `json:"id,omitempty"` // The third-party API ID of original entity DownstreamID *string `json:"downstream_id,omitempty"` + // Id to be displayed. + DisplayID *string `json:"display_id,omitempty"` // Reference to supplier bill number BillNumber *string `json:"bill_number,omitempty"` // The supplier this entity is linked to. Supplier *LinkedSupplier `json:"supplier,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Currency *Currency `json:"currency,omitempty"` // Currency Exchange Rate at the time entity was recorded/generated. @@ -112,6 +149,16 @@ type Bill struct { BankAccount *BankAccount `json:"bank_account,omitempty"` // Discount percentage applied to this transaction. DiscountPercentage *float64 `json:"discount_percentage,omitempty"` + // Optional bill template + TemplateID *string `json:"template_id,omitempty"` + // The user who approved the bill + ApprovedBy *string `json:"approved_by,omitempty"` + // Type of amortization + AmortizationType *BillAmortizationType `json:"amortization_type,omitempty"` + // Method of tax calculation + TaxMethod *string `json:"tax_method,omitempty"` + // Whether the document has been received + DocumentReceived *bool `json:"document_received,omitempty"` // URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. SourceDocumentURL *string `json:"source_document_url,omitempty"` // A list of linked tracking categories. @@ -132,7 +179,8 @@ type Bill struct { // The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. PassThrough []PassThroughBody `json:"pass_through,omitempty"` // Accounting period - AccountingPeriod *string `json:"accounting_period,omitempty"` + AccountingPeriod *string `json:"accounting_period,omitempty"` + Attachments []*LinkedAttachment `json:"attachments,omitempty"` } func (b Bill) MarshalJSON() ([]byte, error) { @@ -160,6 +208,13 @@ func (o *Bill) GetDownstreamID() *string { return o.DownstreamID } +func (o *Bill) GetDisplayID() *string { + if o == nil { + return nil + } + return o.DisplayID +} + func (o *Bill) GetBillNumber() *string { if o == nil { return nil @@ -181,6 +236,13 @@ func (o *Bill) GetCompanyID() *string { return o.CompanyID } +func (o *Bill) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *Bill) GetCurrency() *Currency { if o == nil { return nil @@ -356,6 +418,41 @@ func (o *Bill) GetDiscountPercentage() *float64 { return o.DiscountPercentage } +func (o *Bill) GetTemplateID() *string { + if o == nil { + return nil + } + return o.TemplateID +} + +func (o *Bill) GetApprovedBy() *string { + if o == nil { + return nil + } + return o.ApprovedBy +} + +func (o *Bill) GetAmortizationType() *BillAmortizationType { + if o == nil { + return nil + } + return o.AmortizationType +} + +func (o *Bill) GetTaxMethod() *string { + if o == nil { + return nil + } + return o.TaxMethod +} + +func (o *Bill) GetDocumentReceived() *bool { + if o == nil { + return nil + } + return o.DocumentReceived +} + func (o *Bill) GetSourceDocumentURL() *string { if o == nil { return nil @@ -433,13 +530,24 @@ func (o *Bill) GetAccountingPeriod() *string { return o.AccountingPeriod } +func (o *Bill) GetAttachments() []*LinkedAttachment { + if o == nil { + return nil + } + return o.Attachments +} + type BillInput struct { + // Id to be displayed. + DisplayID *string `json:"display_id,omitempty"` // Reference to supplier bill number BillNumber *string `json:"bill_number,omitempty"` // The supplier this entity is linked to. Supplier *LinkedSupplierInput `json:"supplier,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Currency *Currency `json:"currency,omitempty"` // Currency Exchange Rate at the time entity was recorded/generated. @@ -486,6 +594,16 @@ type BillInput struct { BankAccount *BankAccount `json:"bank_account,omitempty"` // Discount percentage applied to this transaction. DiscountPercentage *float64 `json:"discount_percentage,omitempty"` + // Optional bill template + TemplateID *string `json:"template_id,omitempty"` + // The user who approved the bill + ApprovedBy *string `json:"approved_by,omitempty"` + // Type of amortization + AmortizationType *BillAmortizationType `json:"amortization_type,omitempty"` + // Method of tax calculation + TaxMethod *string `json:"tax_method,omitempty"` + // Whether the document has been received + DocumentReceived *bool `json:"document_received,omitempty"` // URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. SourceDocumentURL *string `json:"source_document_url,omitempty"` // A list of linked tracking categories. @@ -496,7 +614,8 @@ type BillInput struct { // The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. PassThrough []PassThroughBody `json:"pass_through,omitempty"` // Accounting period - AccountingPeriod *string `json:"accounting_period,omitempty"` + AccountingPeriod *string `json:"accounting_period,omitempty"` + Attachments []*LinkedAttachment `json:"attachments,omitempty"` } func (b BillInput) MarshalJSON() ([]byte, error) { @@ -510,6 +629,13 @@ func (b *BillInput) UnmarshalJSON(data []byte) error { return nil } +func (o *BillInput) GetDisplayID() *string { + if o == nil { + return nil + } + return o.DisplayID +} + func (o *BillInput) GetBillNumber() *string { if o == nil { return nil @@ -531,6 +657,13 @@ func (o *BillInput) GetCompanyID() *string { return o.CompanyID } +func (o *BillInput) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *BillInput) GetCurrency() *Currency { if o == nil { return nil @@ -706,6 +839,41 @@ func (o *BillInput) GetDiscountPercentage() *float64 { return o.DiscountPercentage } +func (o *BillInput) GetTemplateID() *string { + if o == nil { + return nil + } + return o.TemplateID +} + +func (o *BillInput) GetApprovedBy() *string { + if o == nil { + return nil + } + return o.ApprovedBy +} + +func (o *BillInput) GetAmortizationType() *BillAmortizationType { + if o == nil { + return nil + } + return o.AmortizationType +} + +func (o *BillInput) GetTaxMethod() *string { + if o == nil { + return nil + } + return o.TaxMethod +} + +func (o *BillInput) GetDocumentReceived() *bool { + if o == nil { + return nil + } + return o.DocumentReceived +} + func (o *BillInput) GetSourceDocumentURL() *string { if o == nil { return nil @@ -747,3 +915,10 @@ func (o *BillInput) GetAccountingPeriod() *string { } return o.AccountingPeriod } + +func (o *BillInput) GetAttachments() []*LinkedAttachment { + if o == nil { + return nil + } + return o.Attachments +} diff --git a/src/__tests__/mockserver/internal/sdk/models/components/billlineitem.go b/src/__tests__/mockserver/internal/sdk/models/components/billlineitem.go index 1fe849f9..fab0477c 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/billlineitem.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/billlineitem.go @@ -71,7 +71,23 @@ type BillLineItem struct { // The ID of the subsidiary SubsidiaryID *string `json:"subsidiary_id,omitempty"` // ID of the category of the line item - CategoryID *string `json:"category_id,omitempty"` + CategoryID *string `json:"category_id,omitempty"` + // ID of the shipping of the line item + ShippingID *string `json:"shipping_id,omitempty"` + // Memo + Memo *string `json:"memo,omitempty"` + // Whether the line item is prepaid + Prepaid *bool `json:"prepaid,omitempty"` + // Tax applicable on + TaxApplicableOn *string `json:"tax_applicable_on,omitempty"` + // Tax recoverability + TaxRecoverability *string `json:"tax_recoverability,omitempty"` + // Method of tax calculation + TaxMethod *string `json:"tax_method,omitempty"` + // Retention amount + RetentionAmount *float64 `json:"retention_amount,omitempty"` + // Payment amount + PaymentAmount *float64 `json:"payment_amount,omitempty"` Item *LinkedInvoiceItem `json:"item,omitempty"` TaxRate *LinkedTaxRate `json:"tax_rate,omitempty"` LedgerAccount *LinkedLedgerAccount `json:"ledger_account,omitempty"` @@ -92,6 +108,8 @@ type BillLineItem struct { CreatedAt *time.Time `json:"created_at,omitempty"` // The date and time when the object was last updated. UpdatedAt *time.Time `json:"updated_at,omitempty"` + // A list of linked worktags. This is only supported for Workday. + Worktags []*LinkedWorktag `json:"worktags,omitempty"` } func (b BillLineItem) MarshalJSON() ([]byte, error) { @@ -224,6 +242,62 @@ func (o *BillLineItem) GetCategoryID() *string { return o.CategoryID } +func (o *BillLineItem) GetShippingID() *string { + if o == nil { + return nil + } + return o.ShippingID +} + +func (o *BillLineItem) GetMemo() *string { + if o == nil { + return nil + } + return o.Memo +} + +func (o *BillLineItem) GetPrepaid() *bool { + if o == nil { + return nil + } + return o.Prepaid +} + +func (o *BillLineItem) GetTaxApplicableOn() *string { + if o == nil { + return nil + } + return o.TaxApplicableOn +} + +func (o *BillLineItem) GetTaxRecoverability() *string { + if o == nil { + return nil + } + return o.TaxRecoverability +} + +func (o *BillLineItem) GetTaxMethod() *string { + if o == nil { + return nil + } + return o.TaxMethod +} + +func (o *BillLineItem) GetRetentionAmount() *float64 { + if o == nil { + return nil + } + return o.RetentionAmount +} + +func (o *BillLineItem) GetPaymentAmount() *float64 { + if o == nil { + return nil + } + return o.PaymentAmount +} + func (o *BillLineItem) GetItem() *LinkedInvoiceItem { if o == nil { return nil @@ -308,6 +382,13 @@ func (o *BillLineItem) GetUpdatedAt() *time.Time { return o.UpdatedAt } +func (o *BillLineItem) GetWorktags() []*LinkedWorktag { + if o == nil { + return nil + } + return o.Worktags +} + type BillLineItemInput struct { // Row ID RowID *string `json:"row_id,omitempty"` @@ -338,7 +419,23 @@ type BillLineItemInput struct { // The ID of the subsidiary SubsidiaryID *string `json:"subsidiary_id,omitempty"` // ID of the category of the line item - CategoryID *string `json:"category_id,omitempty"` + CategoryID *string `json:"category_id,omitempty"` + // ID of the shipping of the line item + ShippingID *string `json:"shipping_id,omitempty"` + // Memo + Memo *string `json:"memo,omitempty"` + // Whether the line item is prepaid + Prepaid *bool `json:"prepaid,omitempty"` + // Tax applicable on + TaxApplicableOn *string `json:"tax_applicable_on,omitempty"` + // Tax recoverability + TaxRecoverability *string `json:"tax_recoverability,omitempty"` + // Method of tax calculation + TaxMethod *string `json:"tax_method,omitempty"` + // Retention amount + RetentionAmount *float64 `json:"retention_amount,omitempty"` + // Payment amount + PaymentAmount *float64 `json:"payment_amount,omitempty"` Item *LinkedInvoiceItem `json:"item,omitempty"` TaxRate *LinkedTaxRateInput `json:"tax_rate,omitempty"` LedgerAccount *LinkedLedgerAccountInput `json:"ledger_account,omitempty"` @@ -351,6 +448,8 @@ type BillLineItemInput struct { Rebilling *Rebilling `json:"rebilling,omitempty"` // 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. RowVersion *string `json:"row_version,omitempty"` + // A list of linked worktags. This is only supported for Workday. + Worktags []*LinkedWorktag `json:"worktags,omitempty"` } func (o *BillLineItemInput) GetRowID() *string { @@ -465,6 +564,62 @@ func (o *BillLineItemInput) GetCategoryID() *string { return o.CategoryID } +func (o *BillLineItemInput) GetShippingID() *string { + if o == nil { + return nil + } + return o.ShippingID +} + +func (o *BillLineItemInput) GetMemo() *string { + if o == nil { + return nil + } + return o.Memo +} + +func (o *BillLineItemInput) GetPrepaid() *bool { + if o == nil { + return nil + } + return o.Prepaid +} + +func (o *BillLineItemInput) GetTaxApplicableOn() *string { + if o == nil { + return nil + } + return o.TaxApplicableOn +} + +func (o *BillLineItemInput) GetTaxRecoverability() *string { + if o == nil { + return nil + } + return o.TaxRecoverability +} + +func (o *BillLineItemInput) GetTaxMethod() *string { + if o == nil { + return nil + } + return o.TaxMethod +} + +func (o *BillLineItemInput) GetRetentionAmount() *float64 { + if o == nil { + return nil + } + return o.RetentionAmount +} + +func (o *BillLineItemInput) GetPaymentAmount() *float64 { + if o == nil { + return nil + } + return o.PaymentAmount +} + func (o *BillLineItemInput) GetItem() *LinkedInvoiceItem { if o == nil { return nil @@ -520,3 +675,10 @@ func (o *BillLineItemInput) GetRowVersion() *string { } return o.RowVersion } + +func (o *BillLineItemInput) GetWorktags() []*LinkedWorktag { + if o == nil { + return nil + } + return o.Worktags +} diff --git a/src/__tests__/mockserver/internal/sdk/models/components/billpayment.go b/src/__tests__/mockserver/internal/sdk/models/components/billpayment.go index 3b3b2cab..1b81d69d 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/billpayment.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/billpayment.go @@ -155,7 +155,7 @@ type BillPayment struct { TransactionDate *time.Time `json:"transaction_date"` // The supplier this entity is linked to. Supplier *LinkedSupplier `json:"supplier,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // Indicates if the transaction has been reconciled. Reconciled *bool `json:"reconciled,omitempty"` @@ -462,7 +462,7 @@ type BillPaymentInput struct { TransactionDate *time.Time `json:"transaction_date"` // The supplier this entity is linked to. Supplier *LinkedSupplierInput `json:"supplier,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // Indicates if the transaction has been reconciled. Reconciled *bool `json:"reconciled,omitempty"` diff --git a/src/__tests__/mockserver/internal/sdk/models/components/creditnote.go b/src/__tests__/mockserver/internal/sdk/models/components/creditnote.go index 76402833..9bd09cb7 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/creditnote.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/creditnote.go @@ -79,8 +79,10 @@ type CreditNote struct { Number *string `json:"number,omitempty"` // The customer this entity is linked to. Customer *LinkedCustomer `json:"customer,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Currency *Currency `json:"currency,omitempty"` // Currency Exchange Rate at the time entity was recorded/generated. @@ -176,6 +178,13 @@ func (o *CreditNote) GetCompanyID() *string { return o.CompanyID } +func (o *CreditNote) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *CreditNote) GetCurrency() *Currency { if o == nil { return nil @@ -391,8 +400,10 @@ type CreditNoteInput struct { Number *string `json:"number,omitempty"` // The customer this entity is linked to. Customer *LinkedCustomerInput `json:"customer,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Currency *Currency `json:"currency,omitempty"` // Currency Exchange Rate at the time entity was recorded/generated. @@ -471,6 +482,13 @@ func (o *CreditNoteInput) GetCompanyID() *string { return o.CompanyID } +func (o *CreditNoteInput) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *CreditNoteInput) GetCurrency() *Currency { if o == nil { return nil diff --git a/src/__tests__/mockserver/internal/sdk/models/components/customer.go b/src/__tests__/mockserver/internal/sdk/models/components/customer.go index 8872026b..57083459 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/customer.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/customer.go @@ -56,7 +56,7 @@ type Customer struct { DisplayName *string `json:"display_name,omitempty"` // The name of the company. CompanyName *string `json:"company_name,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // The job title of the person. Title *string `json:"title,omitempty"` @@ -371,7 +371,7 @@ type CustomerInput struct { DisplayName *string `json:"display_name,omitempty"` // The name of the company. CompanyName *string `json:"company_name,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // The job title of the person. Title *string `json:"title,omitempty"` diff --git a/src/__tests__/mockserver/internal/sdk/models/components/expense.go b/src/__tests__/mockserver/internal/sdk/models/components/expense.go index 998a0aba..c1cb0e29 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/expense.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/expense.go @@ -79,7 +79,7 @@ type Expense struct { CustomerID *string `json:"customer_id,omitempty"` // The ID of the supplier this entity is linked to. SupplierID *string `json:"supplier_id,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // The ID of the department DepartmentID *string `json:"department_id,omitempty"` @@ -323,7 +323,7 @@ type ExpenseInput struct { CustomerID *string `json:"customer_id,omitempty"` // The ID of the supplier this entity is linked to. SupplierID *string `json:"supplier_id,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // The ID of the department DepartmentID *string `json:"department_id,omitempty"` diff --git a/src/__tests__/mockserver/internal/sdk/models/components/invoice.go b/src/__tests__/mockserver/internal/sdk/models/components/invoice.go index c1b74d5e..434ee067 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/invoice.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/invoice.go @@ -140,14 +140,18 @@ type Invoice struct { ID *string `json:"id,omitempty"` // The third-party API ID of original entity DownstreamID *string `json:"downstream_id,omitempty"` + // Id to be displayed. + DisplayID *string `json:"display_id,omitempty"` // Invoice type Type *InvoiceType `json:"type,omitempty"` // Invoice number. Number *string `json:"number,omitempty"` // The customer this entity is linked to. Customer *LinkedCustomer `json:"customer,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // Date invoice was issued - YYYY-MM-DD. InvoiceDate *types.Date `json:"invoice_date,omitempty"` // The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. @@ -251,6 +255,13 @@ func (o *Invoice) GetDownstreamID() *string { return o.DownstreamID } +func (o *Invoice) GetDisplayID() *string { + if o == nil { + return nil + } + return o.DisplayID +} + func (o *Invoice) GetType() *InvoiceType { if o == nil { return nil @@ -279,6 +290,13 @@ func (o *Invoice) GetCompanyID() *string { return o.CompanyID } +func (o *Invoice) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *Invoice) GetInvoiceDate() *types.Date { if o == nil { return nil @@ -567,14 +585,18 @@ func (o *Invoice) GetPassThrough() []PassThroughBody { } type InvoiceInput struct { + // Id to be displayed. + DisplayID *string `json:"display_id,omitempty"` // Invoice type Type *InvoiceType `json:"type,omitempty"` // Invoice number. Number *string `json:"number,omitempty"` // The customer this entity is linked to. Customer *LinkedCustomerInput `json:"customer,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // Date invoice was issued - YYYY-MM-DD. InvoiceDate *types.Date `json:"invoice_date,omitempty"` // The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. @@ -654,6 +676,13 @@ func (i *InvoiceInput) UnmarshalJSON(data []byte) error { return nil } +func (o *InvoiceInput) GetDisplayID() *string { + if o == nil { + return nil + } + return o.DisplayID +} + func (o *InvoiceInput) GetType() *InvoiceType { if o == nil { return nil @@ -682,6 +711,13 @@ func (o *InvoiceInput) GetCompanyID() *string { return o.CompanyID } +func (o *InvoiceInput) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *InvoiceInput) GetInvoiceDate() *types.Date { if o == nil { return nil diff --git a/src/__tests__/mockserver/internal/sdk/models/components/invoicelineitem.go b/src/__tests__/mockserver/internal/sdk/models/components/invoicelineitem.go index f7ca7545..e1998d42 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/invoicelineitem.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/invoicelineitem.go @@ -48,36 +48,6 @@ func (e *InvoiceLineItemType) UnmarshalJSON(data []byte) error { } } -// Budget of the line item -type Budget string - -const ( - BudgetOutOfBudget Budget = "out_of_budget" - BudgetInBudget Budget = "in_budget" - BudgetOther Budget = "other" -) - -func (e Budget) ToPointer() *Budget { - return &e -} -func (e *Budget) UnmarshalJSON(data []byte) error { - var v string - if err := json.Unmarshal(data, &v); err != nil { - return err - } - switch v { - case "out_of_budget": - fallthrough - case "in_budget": - fallthrough - case "other": - *e = Budget(v) - return nil - default: - return fmt.Errorf("invalid value for Budget: %v", v) - } -} - type InvoiceLineItem struct { // A unique identifier for an object. ID *string `json:"id,omitempty"` @@ -124,11 +94,9 @@ type InvoiceLineItem struct { TaxRecoverability *string `json:"tax_recoverability,omitempty"` // Method of tax calculation TaxMethod *string `json:"tax_method,omitempty"` - // Budget of the line item - Budget *Budget `json:"budget,omitempty"` - // ID of the project of the line item - ProjectID *string `json:"project_id,omitempty"` - TaxRate *LinkedTaxRate `json:"tax_rate,omitempty"` + // Worktags of the line item. This is currently only supported in Workday. + Worktags []*LinkedWorktag `json:"worktags,omitempty"` + TaxRate *LinkedTaxRate `json:"tax_rate,omitempty"` // A list of linked tracking categories. TrackingCategories []*LinkedTrackingCategory `json:"tracking_categories,omitempty"` LedgerAccount *LinkedLedgerAccount `json:"ledger_account,omitempty"` @@ -324,18 +292,11 @@ func (o *InvoiceLineItem) GetTaxMethod() *string { return o.TaxMethod } -func (o *InvoiceLineItem) GetBudget() *Budget { - if o == nil { - return nil - } - return o.Budget -} - -func (o *InvoiceLineItem) GetProjectID() *string { +func (o *InvoiceLineItem) GetWorktags() []*LinkedWorktag { if o == nil { return nil } - return o.ProjectID + return o.Worktags } func (o *InvoiceLineItem) GetTaxRate() *LinkedTaxRate { @@ -447,11 +408,9 @@ type InvoiceLineItemInput struct { TaxRecoverability *string `json:"tax_recoverability,omitempty"` // Method of tax calculation TaxMethod *string `json:"tax_method,omitempty"` - // Budget of the line item - Budget *Budget `json:"budget,omitempty"` - // ID of the project of the line item - ProjectID *string `json:"project_id,omitempty"` - TaxRate *LinkedTaxRateInput `json:"tax_rate,omitempty"` + // Worktags of the line item. This is currently only supported in Workday. + Worktags []*LinkedWorktag `json:"worktags,omitempty"` + TaxRate *LinkedTaxRateInput `json:"tax_rate,omitempty"` // A list of linked tracking categories. TrackingCategories []*LinkedTrackingCategory `json:"tracking_categories,omitempty"` LedgerAccount *LinkedLedgerAccountInput `json:"ledger_account,omitempty"` @@ -628,18 +587,11 @@ func (o *InvoiceLineItemInput) GetTaxMethod() *string { return o.TaxMethod } -func (o *InvoiceLineItemInput) GetBudget() *Budget { - if o == nil { - return nil - } - return o.Budget -} - -func (o *InvoiceLineItemInput) GetProjectID() *string { +func (o *InvoiceLineItemInput) GetWorktags() []*LinkedWorktag { if o == nil { return nil } - return o.ProjectID + return o.Worktags } func (o *InvoiceLineItemInput) GetTaxRate() *LinkedTaxRateInput { diff --git a/src/__tests__/mockserver/internal/sdk/models/components/journalentry.go b/src/__tests__/mockserver/internal/sdk/models/components/journalentry.go index b7a05d93..8b59048b 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/journalentry.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/journalentry.go @@ -63,7 +63,7 @@ type JournalEntry struct { CurrencyRate *float64 `json:"currency_rate,omitempty"` // Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Currency *Currency `json:"currency,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // Requires a minimum of 2 line items that sum to 0 LineItems []JournalEntryLineItem `json:"line_items,omitempty"` @@ -281,7 +281,7 @@ type JournalEntryInput struct { CurrencyRate *float64 `json:"currency_rate,omitempty"` // Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Currency *Currency `json:"currency,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // Requires a minimum of 2 line items that sum to 0 LineItems []JournalEntryLineItemInput `json:"line_items,omitempty"` diff --git a/src/__tests__/mockserver/internal/sdk/models/components/linkedattachment.go b/src/__tests__/mockserver/internal/sdk/models/components/linkedattachment.go new file mode 100644 index 00000000..ed7c7f4b --- /dev/null +++ b/src/__tests__/mockserver/internal/sdk/models/components/linkedattachment.go @@ -0,0 +1,60 @@ +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +package components + +type LinkedAttachment struct { + // The name of the file + Name *string `json:"name,omitempty"` + // The MIME type of the file. + MimeType *string `json:"mime_type,omitempty"` + // Whether the file is c ompressed. + IsCompressed *bool `json:"is_compressed,omitempty"` + // The encoding of the file. + Encoding *string `json:"encoding,omitempty"` + // The content of the file. + Content *string `json:"content,omitempty"` + // The notes of the file. + Notes *string `json:"notes,omitempty"` +} + +func (o *LinkedAttachment) GetName() *string { + if o == nil { + return nil + } + return o.Name +} + +func (o *LinkedAttachment) GetMimeType() *string { + if o == nil { + return nil + } + return o.MimeType +} + +func (o *LinkedAttachment) GetIsCompressed() *bool { + if o == nil { + return nil + } + return o.IsCompressed +} + +func (o *LinkedAttachment) GetEncoding() *string { + if o == nil { + return nil + } + return o.Encoding +} + +func (o *LinkedAttachment) GetContent() *string { + if o == nil { + return nil + } + return o.Content +} + +func (o *LinkedAttachment) GetNotes() *string { + if o == nil { + return nil + } + return o.Notes +} diff --git a/src/__tests__/mockserver/internal/sdk/models/components/linkedworktag.go b/src/__tests__/mockserver/internal/sdk/models/components/linkedworktag.go new file mode 100644 index 00000000..2931207e --- /dev/null +++ b/src/__tests__/mockserver/internal/sdk/models/components/linkedworktag.go @@ -0,0 +1,24 @@ +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +package components + +type LinkedWorktag struct { + // The unique identifier for the worktag. + ID *string `json:"id,omitempty"` + // The value of the worktag. + Value *string `json:"value,omitempty"` +} + +func (o *LinkedWorktag) GetID() *string { + if o == nil { + return nil + } + return o.ID +} + +func (o *LinkedWorktag) GetValue() *string { + if o == nil { + return nil + } + return o.Value +} diff --git a/src/__tests__/mockserver/internal/sdk/models/components/payment.go b/src/__tests__/mockserver/internal/sdk/models/components/payment.go index a235d525..d19235a0 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/payment.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/payment.go @@ -43,7 +43,7 @@ type Payment struct { // // Deprecated: This will be removed in a future release, please migrate away from it as soon as possible. Supplier *DeprecatedLinkedSupplier `json:"supplier,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // Indicates if the transaction has been reconciled. Reconciled *bool `json:"reconciled,omitempty"` diff --git a/src/__tests__/mockserver/internal/sdk/models/components/paymentinput.go b/src/__tests__/mockserver/internal/sdk/models/components/paymentinput.go index 4cb02d17..36a9400a 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/paymentinput.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/paymentinput.go @@ -39,7 +39,7 @@ type PaymentInput struct { // // Deprecated: This will be removed in a future release, please migrate away from it as soon as possible. Supplier *DeprecatedLinkedSupplierInput `json:"supplier,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // Indicates if the transaction has been reconciled. Reconciled *bool `json:"reconciled,omitempty"` diff --git a/src/__tests__/mockserver/internal/sdk/models/components/purchaseorder.go b/src/__tests__/mockserver/internal/sdk/models/components/purchaseorder.go index 77a0bad5..50ec9903 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/purchaseorder.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/purchaseorder.go @@ -48,20 +48,20 @@ func (e *PurchaseOrderStatus) UnmarshalJSON(data []byte) error { } } -// AmortizationType - Type of amortization -type AmortizationType string +// PurchaseOrderAmortizationType - Type of amortization +type PurchaseOrderAmortizationType string const ( - AmortizationTypeManual AmortizationType = "manual" - AmortizationTypeReceipt AmortizationType = "receipt" - AmortizationTypeSchedule AmortizationType = "schedule" - AmortizationTypeOther AmortizationType = "other" + PurchaseOrderAmortizationTypeManual PurchaseOrderAmortizationType = "manual" + PurchaseOrderAmortizationTypeReceipt PurchaseOrderAmortizationType = "receipt" + PurchaseOrderAmortizationTypeSchedule PurchaseOrderAmortizationType = "schedule" + PurchaseOrderAmortizationTypeOther PurchaseOrderAmortizationType = "other" ) -func (e AmortizationType) ToPointer() *AmortizationType { +func (e PurchaseOrderAmortizationType) ToPointer() *PurchaseOrderAmortizationType { return &e } -func (e *AmortizationType) UnmarshalJSON(data []byte) error { +func (e *PurchaseOrderAmortizationType) UnmarshalJSON(data []byte) error { var v string if err := json.Unmarshal(data, &v); err != nil { return err @@ -74,10 +74,10 @@ func (e *AmortizationType) UnmarshalJSON(data []byte) error { case "schedule": fallthrough case "other": - *e = AmortizationType(v) + *e = PurchaseOrderAmortizationType(v) return nil default: - return fmt.Errorf("invalid value for AmortizationType: %v", v) + return fmt.Errorf("invalid value for PurchaseOrderAmortizationType: %v", v) } } @@ -94,9 +94,11 @@ type PurchaseOrder struct { Supplier *LinkedSupplier `json:"supplier,omitempty"` // The ID of the subsidiary SubsidiaryID *string `json:"subsidiary_id,omitempty"` - // The company or subsidiary id the transaction belongs to - CompanyID *string `json:"company_id,omitempty"` - Status *PurchaseOrderStatus `json:"status,omitempty"` + // The company ID the transaction belongs to + CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` + Status *PurchaseOrderStatus `json:"status,omitempty"` // Date purchase order was issued - YYYY-MM-DD. IssuedDate *types.Date `json:"issued_date,omitempty"` // The date on which the purchase order is to be delivered - YYYY-MM-DD. @@ -133,7 +135,7 @@ type PurchaseOrder struct { // Terms of payment. Terms *string `json:"terms,omitempty"` // Type of amortization - AmortizationType *AmortizationType `json:"amortization_type,omitempty"` + AmortizationType *PurchaseOrderAmortizationType `json:"amortization_type,omitempty"` // Applicable tax id/code override if tax is not supplied on a line item basis. TaxCode *string `json:"tax_code,omitempty"` // Method of tax calculation @@ -227,6 +229,13 @@ func (o *PurchaseOrder) GetCompanyID() *string { return o.CompanyID } +func (o *PurchaseOrder) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *PurchaseOrder) GetStatus() *PurchaseOrderStatus { if o == nil { return nil @@ -374,7 +383,7 @@ func (o *PurchaseOrder) GetTerms() *string { return o.Terms } -func (o *PurchaseOrder) GetAmortizationType() *AmortizationType { +func (o *PurchaseOrder) GetAmortizationType() *PurchaseOrderAmortizationType { if o == nil { return nil } @@ -502,9 +511,11 @@ type PurchaseOrderInput struct { Supplier *LinkedSupplierInput `json:"supplier,omitempty"` // The ID of the subsidiary SubsidiaryID *string `json:"subsidiary_id,omitempty"` - // The company or subsidiary id the transaction belongs to - CompanyID *string `json:"company_id,omitempty"` - Status *PurchaseOrderStatus `json:"status,omitempty"` + // The company ID the transaction belongs to + CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` + Status *PurchaseOrderStatus `json:"status,omitempty"` // Date purchase order was issued - YYYY-MM-DD. IssuedDate *types.Date `json:"issued_date,omitempty"` // The date on which the purchase order is to be delivered - YYYY-MM-DD. @@ -541,7 +552,7 @@ type PurchaseOrderInput struct { // Terms of payment. Terms *string `json:"terms,omitempty"` // Type of amortization - AmortizationType *AmortizationType `json:"amortization_type,omitempty"` + AmortizationType *PurchaseOrderAmortizationType `json:"amortization_type,omitempty"` // Applicable tax id/code override if tax is not supplied on a line item basis. TaxCode *string `json:"tax_code,omitempty"` // Method of tax calculation @@ -611,6 +622,13 @@ func (o *PurchaseOrderInput) GetCompanyID() *string { return o.CompanyID } +func (o *PurchaseOrderInput) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *PurchaseOrderInput) GetStatus() *PurchaseOrderStatus { if o == nil { return nil @@ -758,7 +776,7 @@ func (o *PurchaseOrderInput) GetTerms() *string { return o.Terms } -func (o *PurchaseOrderInput) GetAmortizationType() *AmortizationType { +func (o *PurchaseOrderInput) GetAmortizationType() *PurchaseOrderAmortizationType { if o == nil { return nil } diff --git a/src/__tests__/mockserver/internal/sdk/models/components/quote.go b/src/__tests__/mockserver/internal/sdk/models/components/quote.go index 2b5a68a3..ded044db 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/quote.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/quote.go @@ -68,8 +68,10 @@ type Quote struct { InvoiceID *string `json:"invoice_id,omitempty"` // The unique identifier for the sales order. SalesOrderID *string `json:"sales_order_id,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // The unique identifier for the linked project. ProjectID *string `json:"project_id,omitempty"` // Date quote was issued - YYYY-MM-DD. @@ -186,6 +188,13 @@ func (o *Quote) GetCompanyID() *string { return o.CompanyID } +func (o *Quote) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *Quote) GetProjectID() *string { if o == nil { return nil @@ -396,8 +405,10 @@ type QuoteInput struct { Customer *LinkedCustomerInput `json:"customer,omitempty"` // The unique identifier for the sales order. SalesOrderID *string `json:"sales_order_id,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` + // The ID of the department + DepartmentID *string `json:"department_id,omitempty"` // The unique identifier for the linked project. ProjectID *string `json:"project_id,omitempty"` // Date quote was issued - YYYY-MM-DD. @@ -485,6 +496,13 @@ func (o *QuoteInput) GetCompanyID() *string { return o.CompanyID } +func (o *QuoteInput) GetDepartmentID() *string { + if o == nil { + return nil + } + return o.DepartmentID +} + func (o *QuoteInput) GetProjectID() *string { if o == nil { return nil diff --git a/src/__tests__/mockserver/internal/sdk/models/components/supplier.go b/src/__tests__/mockserver/internal/sdk/models/components/supplier.go index 73cba1f7..9195e40d 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/supplier.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/supplier.go @@ -56,7 +56,7 @@ type Supplier struct { DisplayName *string `json:"display_name,omitempty"` // The name of the company. CompanyName *string `json:"company_name,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // The category/type of the supplier SupplierCategory *string `json:"supplier_category,omitempty"` @@ -380,7 +380,7 @@ type SupplierInput struct { DisplayName *string `json:"display_name,omitempty"` // The name of the company. CompanyName *string `json:"company_name,omitempty"` - // The company or subsidiary id the transaction belongs to + // The company ID the transaction belongs to CompanyID *string `json:"company_id,omitempty"` // The category/type of the supplier SupplierCategory *string `json:"supplier_category,omitempty"` diff --git a/src/__tests__/quotes.test.ts b/src/__tests__/quotes.test.ts index 5d4dbfb3..43983fd0 100644 --- a/src/__tests__/quotes.test.ts +++ b/src/__tests__/quotes.test.ts @@ -70,6 +70,7 @@ test("Quotes Accounting Quotes Add", async () => { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), @@ -277,6 +278,7 @@ test("Quotes Accounting Quotes One", async () => { invoiceId: "123456", salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), @@ -469,6 +471,7 @@ test("Quotes Accounting Quotes Update", async () => { }, salesOrderId: "123456", companyId: "12345", + departmentId: "12345", projectId: "12345", quoteDate: new RFCDate("2020-09-30"), expiryDate: new RFCDate("2020-10-30"), diff --git a/src/lib/config.ts b/src/lib/config.ts index 6aa54837..37aa7e17 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -67,8 +67,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", - openapiDocVersion: "10.20.2", - sdkVersion: "0.29.2", - genVersion: "2.674.3", - userAgent: "speakeasy-sdk/typescript 0.29.2 2.674.3 10.20.2 @apideck/unify", + openapiDocVersion: "10.20.6", + sdkVersion: "0.29.3", + genVersion: "2.681.1", + userAgent: "speakeasy-sdk/typescript 0.29.3 2.681.1 10.20.6 @apideck/unify", } as const; diff --git a/src/models/components/applicant.ts b/src/models/components/applicant.ts index 391d64b1..4fe72e56 100644 --- a/src/models/components/applicant.ts +++ b/src/models/components/applicant.ts @@ -40,6 +40,21 @@ import { PhoneNumber$outboundSchema, } from "./phonenumber.js"; +/** + * The gender represents the gender identity of a person. + */ +export const ApplicantGender = { + Male: "male", + Female: "female", + Unisex: "unisex", + Other: "other", + NotSpecified: "not_specified", +} as const; +/** + * The gender represents the gender identity of a person. + */ +export type ApplicantGender = ClosedEnum; + /** * The type of website */ @@ -94,6 +109,10 @@ export type Applicant = { * The name of an applicant. */ name?: string | undefined; + /** + * A formal salutation for the person. For example, 'Mr', 'Mrs' + */ + salutation?: string | null | undefined; /** * The first name of the person. */ @@ -114,6 +133,15 @@ export type Applicant = { * The date of birth of the person. */ birthday?: RFCDate | null | undefined; + /** + * The gender represents the gender identity of a person. + */ + gender?: ApplicantGender | null | undefined; + /** + * A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + */ + socialSecurityNumber?: string | null | undefined; + type?: string | undefined; coverLetter?: string | undefined; jobUrl?: string | null | undefined; /** @@ -200,6 +228,10 @@ export type ApplicantInput = { * The name of an applicant. */ name?: string | undefined; + /** + * A formal salutation for the person. For example, 'Mr', 'Mrs' + */ + salutation?: string | null | undefined; /** * The first name of the person. */ @@ -220,6 +252,15 @@ export type ApplicantInput = { * The date of birth of the person. */ birthday?: RFCDate | null | undefined; + /** + * The gender represents the gender identity of a person. + */ + gender?: ApplicantGender | null | undefined; + /** + * A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. + */ + socialSecurityNumber?: string | null | undefined; + type?: string | undefined; coverLetter?: string | undefined; /** * The URL of the photo of a person. @@ -267,6 +308,27 @@ export type ApplicantInput = { passThrough?: Array | undefined; }; +/** @internal */ +export const ApplicantGender$inboundSchema: z.ZodNativeEnum< + typeof ApplicantGender +> = z.nativeEnum(ApplicantGender); + +/** @internal */ +export const ApplicantGender$outboundSchema: z.ZodNativeEnum< + typeof ApplicantGender +> = ApplicantGender$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ApplicantGender$ { + /** @deprecated use `ApplicantGender$inboundSchema` instead. */ + export const inboundSchema = ApplicantGender$inboundSchema; + /** @deprecated use `ApplicantGender$outboundSchema` instead. */ + export const outboundSchema = ApplicantGender$outboundSchema; +} + /** @internal */ export const ApplicantType$inboundSchema: z.ZodNativeEnum< typeof ApplicantType @@ -408,11 +470,15 @@ export const Applicant$inboundSchema: z.ZodType< > = z.object({ id: z.string().optional(), name: z.string().optional(), + salutation: z.nullable(z.string()).optional(), first_name: z.nullable(z.string()).optional(), last_name: z.nullable(z.string()).optional(), middle_name: z.nullable(z.string()).optional(), initials: z.nullable(z.string()).optional(), birthday: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), + gender: z.nullable(ApplicantGender$inboundSchema).optional(), + social_security_number: z.nullable(z.string()).optional(), + type: z.string().optional(), cover_letter: z.string().optional(), job_url: z.nullable(z.string()).optional(), photo_url: z.nullable(z.string()).optional(), @@ -466,6 +532,7 @@ export const Applicant$inboundSchema: z.ZodType< "first_name": "firstName", "last_name": "lastName", "middle_name": "middleName", + "social_security_number": "socialSecurityNumber", "cover_letter": "coverLetter", "job_url": "jobUrl", "photo_url": "photoUrl", @@ -498,11 +565,15 @@ export const Applicant$inboundSchema: z.ZodType< export type Applicant$Outbound = { id?: string | undefined; name?: string | undefined; + salutation?: string | null | undefined; first_name?: string | null | undefined; last_name?: string | null | undefined; middle_name?: string | null | undefined; initials?: string | null | undefined; birthday?: string | null | undefined; + gender?: string | null | undefined; + social_security_number?: string | null | undefined; + type?: string | undefined; cover_letter?: string | undefined; job_url?: string | null | undefined; photo_url?: string | null | undefined; @@ -551,12 +622,16 @@ export const Applicant$outboundSchema: z.ZodType< > = z.object({ id: z.string().optional(), name: z.string().optional(), + salutation: z.nullable(z.string()).optional(), firstName: z.nullable(z.string()).optional(), lastName: z.nullable(z.string()).optional(), middleName: z.nullable(z.string()).optional(), initials: z.nullable(z.string()).optional(), birthday: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), + gender: z.nullable(ApplicantGender$outboundSchema).optional(), + socialSecurityNumber: z.nullable(z.string()).optional(), + type: z.string().optional(), coverLetter: z.string().optional(), jobUrl: z.nullable(z.string()).optional(), photoUrl: z.nullable(z.string()).optional(), @@ -601,6 +676,7 @@ export const Applicant$outboundSchema: z.ZodType< firstName: "first_name", lastName: "last_name", middleName: "middle_name", + socialSecurityNumber: "social_security_number", coverLetter: "cover_letter", jobUrl: "job_url", photoUrl: "photo_url", @@ -663,11 +739,15 @@ export const ApplicantInput$inboundSchema: z.ZodType< unknown > = z.object({ name: z.string().optional(), + salutation: z.nullable(z.string()).optional(), first_name: z.nullable(z.string()).optional(), last_name: z.nullable(z.string()).optional(), middle_name: z.nullable(z.string()).optional(), initials: z.nullable(z.string()).optional(), birthday: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), + gender: z.nullable(ApplicantGender$inboundSchema).optional(), + social_security_number: z.nullable(z.string()).optional(), + type: z.string().optional(), cover_letter: z.string().optional(), photo_url: z.nullable(z.string()).optional(), headline: z.string().optional(), @@ -698,6 +778,7 @@ export const ApplicantInput$inboundSchema: z.ZodType< "first_name": "firstName", "last_name": "lastName", "middle_name": "middleName", + "social_security_number": "socialSecurityNumber", "cover_letter": "coverLetter", "photo_url": "photoUrl", "custom_fields": "customFields", @@ -716,11 +797,15 @@ export const ApplicantInput$inboundSchema: z.ZodType< /** @internal */ export type ApplicantInput$Outbound = { name?: string | undefined; + salutation?: string | null | undefined; first_name?: string | null | undefined; last_name?: string | null | undefined; middle_name?: string | null | undefined; initials?: string | null | undefined; birthday?: string | null | undefined; + gender?: string | null | undefined; + social_security_number?: string | null | undefined; + type?: string | undefined; cover_letter?: string | undefined; photo_url?: string | null | undefined; headline?: string | undefined; @@ -755,12 +840,16 @@ export const ApplicantInput$outboundSchema: z.ZodType< ApplicantInput > = z.object({ name: z.string().optional(), + salutation: z.nullable(z.string()).optional(), firstName: z.nullable(z.string()).optional(), lastName: z.nullable(z.string()).optional(), middleName: z.nullable(z.string()).optional(), initials: z.nullable(z.string()).optional(), birthday: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), + gender: z.nullable(ApplicantGender$outboundSchema).optional(), + socialSecurityNumber: z.nullable(z.string()).optional(), + type: z.string().optional(), coverLetter: z.string().optional(), photoUrl: z.nullable(z.string()).optional(), headline: z.string().optional(), @@ -791,6 +880,7 @@ export const ApplicantInput$outboundSchema: z.ZodType< firstName: "first_name", lastName: "last_name", middleName: "middle_name", + socialSecurityNumber: "social_security_number", coverLetter: "cover_letter", photoUrl: "photo_url", customFields: "custom_fields", diff --git a/src/models/components/bill.ts b/src/models/components/bill.ts index 3b4c815e..0b98dc6d 100644 --- a/src/models/components/bill.ts +++ b/src/models/components/bill.ts @@ -36,6 +36,12 @@ import { CustomField$Outbound, CustomField$outboundSchema, } from "./customfield.js"; +import { + LinkedAttachment, + LinkedAttachment$inboundSchema, + LinkedAttachment$Outbound, + LinkedAttachment$outboundSchema, +} from "./linkedattachment.js"; import { LinkedLedgerAccount, LinkedLedgerAccount$inboundSchema, @@ -91,6 +97,20 @@ export const BillStatus = { */ export type BillStatus = ClosedEnum; +/** + * Type of amortization + */ +export const AmortizationType = { + Manual: "manual", + Receipt: "receipt", + Schedule: "schedule", + Other: "other", +} as const; +/** + * Type of amortization + */ +export type AmortizationType = ClosedEnum; + export type Bill = { /** * A unique identifier for an object. @@ -100,6 +120,10 @@ export type Bill = { * The third-party API ID of original entity */ downstreamId?: string | null | undefined; + /** + * Id to be displayed. + */ + displayId?: string | null | undefined; /** * Reference to supplier bill number */ @@ -109,9 +133,13 @@ export type Bill = { */ supplier?: LinkedSupplier | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). */ @@ -200,6 +228,26 @@ export type Bill = { * Discount percentage applied to this transaction. */ discountPercentage?: number | null | undefined; + /** + * Optional bill template + */ + templateId?: string | null | undefined; + /** + * The user who approved the bill + */ + approvedBy?: string | null | undefined; + /** + * Type of amortization + */ + amortizationType?: AmortizationType | null | undefined; + /** + * Method of tax calculation + */ + taxMethod?: string | null | undefined; + /** + * Whether the document has been received + */ + documentReceived?: boolean | null | undefined; /** * URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. */ @@ -241,9 +289,14 @@ export type Bill = { * Accounting period */ accountingPeriod?: string | null | undefined; + attachments?: Array | undefined; }; export type BillInput = { + /** + * Id to be displayed. + */ + displayId?: string | null | undefined; /** * Reference to supplier bill number */ @@ -253,9 +306,13 @@ export type BillInput = { */ supplier?: LinkedSupplierInput | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). */ @@ -344,6 +401,26 @@ export type BillInput = { * Discount percentage applied to this transaction. */ discountPercentage?: number | null | undefined; + /** + * Optional bill template + */ + templateId?: string | null | undefined; + /** + * The user who approved the bill + */ + approvedBy?: string | null | undefined; + /** + * Type of amortization + */ + amortizationType?: AmortizationType | null | undefined; + /** + * Method of tax calculation + */ + taxMethod?: string | null | undefined; + /** + * Whether the document has been received + */ + documentReceived?: boolean | null | undefined; /** * URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. */ @@ -365,6 +442,7 @@ export type BillInput = { * Accounting period */ accountingPeriod?: string | null | undefined; + attachments?: Array | undefined; }; /** @internal */ @@ -386,14 +464,37 @@ export namespace BillStatus$ { export const outboundSchema = BillStatus$outboundSchema; } +/** @internal */ +export const AmortizationType$inboundSchema: z.ZodNativeEnum< + typeof AmortizationType +> = z.nativeEnum(AmortizationType); + +/** @internal */ +export const AmortizationType$outboundSchema: z.ZodNativeEnum< + typeof AmortizationType +> = AmortizationType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AmortizationType$ { + /** @deprecated use `AmortizationType$inboundSchema` instead. */ + export const inboundSchema = AmortizationType$inboundSchema; + /** @deprecated use `AmortizationType$outboundSchema` instead. */ + export const outboundSchema = AmortizationType$outboundSchema; +} + /** @internal */ export const Bill$inboundSchema: z.ZodType = z .object({ id: z.string().optional(), downstream_id: z.nullable(z.string()).optional(), + display_id: z.nullable(z.string()).optional(), bill_number: z.nullable(z.string()).optional(), supplier: z.nullable(LinkedSupplier$inboundSchema).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), currency: z.nullable(Currency$inboundSchema).optional(), currency_rate: z.nullable(z.number()).optional(), tax_inclusive: z.nullable(z.boolean()).optional(), @@ -419,6 +520,11 @@ export const Bill$inboundSchema: z.ZodType = z accounting_by_row: z.nullable(z.boolean()).optional(), bank_account: BankAccount$inboundSchema.optional(), discount_percentage: z.nullable(z.number()).optional(), + template_id: z.nullable(z.string()).optional(), + approved_by: z.nullable(z.string()).optional(), + amortization_type: z.nullable(AmortizationType$inboundSchema).optional(), + tax_method: z.nullable(z.string()).optional(), + document_received: z.nullable(z.boolean()).optional(), source_document_url: z.nullable(z.string()).optional(), tracking_categories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$inboundSchema)), @@ -436,11 +542,14 @@ export const Bill$inboundSchema: z.ZodType = z custom_mappings: z.nullable(z.record(z.any())).optional(), pass_through: z.array(PassThroughBody$inboundSchema).optional(), accounting_period: z.nullable(z.string()).optional(), + attachments: z.array(z.nullable(LinkedAttachment$inboundSchema)).optional(), }).transform((v) => { return remap$(v, { "downstream_id": "downstreamId", + "display_id": "displayId", "bill_number": "billNumber", "company_id": "companyId", + "department_id": "departmentId", "currency_rate": "currencyRate", "tax_inclusive": "taxInclusive", "bill_date": "billDate", @@ -456,6 +565,11 @@ export const Bill$inboundSchema: z.ZodType = z "accounting_by_row": "accountingByRow", "bank_account": "bankAccount", "discount_percentage": "discountPercentage", + "template_id": "templateId", + "approved_by": "approvedBy", + "amortization_type": "amortizationType", + "tax_method": "taxMethod", + "document_received": "documentReceived", "source_document_url": "sourceDocumentUrl", "tracking_categories": "trackingCategories", "updated_by": "updatedBy", @@ -474,9 +588,11 @@ export const Bill$inboundSchema: z.ZodType = z export type Bill$Outbound = { id?: string | undefined; downstream_id?: string | null | undefined; + display_id?: string | null | undefined; bill_number?: string | null | undefined; supplier?: LinkedSupplier$Outbound | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; currency?: string | null | undefined; currency_rate?: number | null | undefined; tax_inclusive?: boolean | null | undefined; @@ -502,6 +618,11 @@ export type Bill$Outbound = { accounting_by_row?: boolean | null | undefined; bank_account?: BankAccount$Outbound | undefined; discount_percentage?: number | null | undefined; + template_id?: string | null | undefined; + approved_by?: string | null | undefined; + amortization_type?: string | null | undefined; + tax_method?: string | null | undefined; + document_received?: boolean | null | undefined; source_document_url?: string | null | undefined; tracking_categories?: | Array @@ -516,6 +637,7 @@ export type Bill$Outbound = { custom_mappings?: { [k: string]: any } | null | undefined; pass_through?: Array | undefined; accounting_period?: string | null | undefined; + attachments?: Array | undefined; }; /** @internal */ @@ -523,9 +645,11 @@ export const Bill$outboundSchema: z.ZodType = z.object({ id: z.string().optional(), downstreamId: z.nullable(z.string()).optional(), + displayId: z.nullable(z.string()).optional(), billNumber: z.nullable(z.string()).optional(), supplier: z.nullable(LinkedSupplier$outboundSchema).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), currency: z.nullable(Currency$outboundSchema).optional(), currencyRate: z.nullable(z.number()).optional(), taxInclusive: z.nullable(z.boolean()).optional(), @@ -554,6 +678,11 @@ export const Bill$outboundSchema: z.ZodType = accountingByRow: z.nullable(z.boolean()).optional(), bankAccount: BankAccount$outboundSchema.optional(), discountPercentage: z.nullable(z.number()).optional(), + templateId: z.nullable(z.string()).optional(), + approvedBy: z.nullable(z.string()).optional(), + amortizationType: z.nullable(AmortizationType$outboundSchema).optional(), + taxMethod: z.nullable(z.string()).optional(), + documentReceived: z.nullable(z.boolean()).optional(), sourceDocumentUrl: z.nullable(z.string()).optional(), trackingCategories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$outboundSchema)), @@ -567,11 +696,15 @@ export const Bill$outboundSchema: z.ZodType = customMappings: z.nullable(z.record(z.any())).optional(), passThrough: z.array(PassThroughBody$outboundSchema).optional(), accountingPeriod: z.nullable(z.string()).optional(), + attachments: z.array(z.nullable(LinkedAttachment$outboundSchema)) + .optional(), }).transform((v) => { return remap$(v, { downstreamId: "downstream_id", + displayId: "display_id", billNumber: "bill_number", companyId: "company_id", + departmentId: "department_id", currencyRate: "currency_rate", taxInclusive: "tax_inclusive", billDate: "bill_date", @@ -587,6 +720,11 @@ export const Bill$outboundSchema: z.ZodType = accountingByRow: "accounting_by_row", bankAccount: "bank_account", discountPercentage: "discount_percentage", + templateId: "template_id", + approvedBy: "approved_by", + amortizationType: "amortization_type", + taxMethod: "tax_method", + documentReceived: "document_received", sourceDocumentUrl: "source_document_url", trackingCategories: "tracking_categories", updatedBy: "updated_by", @@ -634,9 +772,11 @@ export const BillInput$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + display_id: z.nullable(z.string()).optional(), bill_number: z.nullable(z.string()).optional(), supplier: z.nullable(LinkedSupplierInput$inboundSchema).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), currency: z.nullable(Currency$inboundSchema).optional(), currency_rate: z.nullable(z.number()).optional(), tax_inclusive: z.nullable(z.boolean()).optional(), @@ -662,6 +802,11 @@ export const BillInput$inboundSchema: z.ZodType< accounting_by_row: z.nullable(z.boolean()).optional(), bank_account: BankAccount$inboundSchema.optional(), discount_percentage: z.nullable(z.number()).optional(), + template_id: z.nullable(z.string()).optional(), + approved_by: z.nullable(z.string()).optional(), + amortization_type: z.nullable(AmortizationType$inboundSchema).optional(), + tax_method: z.nullable(z.string()).optional(), + document_received: z.nullable(z.boolean()).optional(), source_document_url: z.nullable(z.string()).optional(), tracking_categories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$inboundSchema)), @@ -670,10 +815,13 @@ export const BillInput$inboundSchema: z.ZodType< custom_fields: z.array(CustomField$inboundSchema).optional(), pass_through: z.array(PassThroughBody$inboundSchema).optional(), accounting_period: z.nullable(z.string()).optional(), + attachments: z.array(z.nullable(LinkedAttachment$inboundSchema)).optional(), }).transform((v) => { return remap$(v, { + "display_id": "displayId", "bill_number": "billNumber", "company_id": "companyId", + "department_id": "departmentId", "currency_rate": "currencyRate", "tax_inclusive": "taxInclusive", "bill_date": "billDate", @@ -689,6 +837,11 @@ export const BillInput$inboundSchema: z.ZodType< "accounting_by_row": "accountingByRow", "bank_account": "bankAccount", "discount_percentage": "discountPercentage", + "template_id": "templateId", + "approved_by": "approvedBy", + "amortization_type": "amortizationType", + "tax_method": "taxMethod", + "document_received": "documentReceived", "source_document_url": "sourceDocumentUrl", "tracking_categories": "trackingCategories", "row_version": "rowVersion", @@ -700,9 +853,11 @@ export const BillInput$inboundSchema: z.ZodType< /** @internal */ export type BillInput$Outbound = { + display_id?: string | null | undefined; bill_number?: string | null | undefined; supplier?: LinkedSupplierInput$Outbound | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; currency?: string | null | undefined; currency_rate?: number | null | undefined; tax_inclusive?: boolean | null | undefined; @@ -728,6 +883,11 @@ export type BillInput$Outbound = { accounting_by_row?: boolean | null | undefined; bank_account?: BankAccount$Outbound | undefined; discount_percentage?: number | null | undefined; + template_id?: string | null | undefined; + approved_by?: string | null | undefined; + amortization_type?: string | null | undefined; + tax_method?: string | null | undefined; + document_received?: boolean | null | undefined; source_document_url?: string | null | undefined; tracking_categories?: | Array @@ -737,6 +897,7 @@ export type BillInput$Outbound = { custom_fields?: Array | undefined; pass_through?: Array | undefined; accounting_period?: string | null | undefined; + attachments?: Array | undefined; }; /** @internal */ @@ -745,9 +906,11 @@ export const BillInput$outboundSchema: z.ZodType< z.ZodTypeDef, BillInput > = z.object({ + displayId: z.nullable(z.string()).optional(), billNumber: z.nullable(z.string()).optional(), supplier: z.nullable(LinkedSupplierInput$outboundSchema).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), currency: z.nullable(Currency$outboundSchema).optional(), currencyRate: z.nullable(z.number()).optional(), taxInclusive: z.nullable(z.boolean()).optional(), @@ -776,6 +939,11 @@ export const BillInput$outboundSchema: z.ZodType< accountingByRow: z.nullable(z.boolean()).optional(), bankAccount: BankAccount$outboundSchema.optional(), discountPercentage: z.nullable(z.number()).optional(), + templateId: z.nullable(z.string()).optional(), + approvedBy: z.nullable(z.string()).optional(), + amortizationType: z.nullable(AmortizationType$outboundSchema).optional(), + taxMethod: z.nullable(z.string()).optional(), + documentReceived: z.nullable(z.boolean()).optional(), sourceDocumentUrl: z.nullable(z.string()).optional(), trackingCategories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$outboundSchema)), @@ -784,10 +952,13 @@ export const BillInput$outboundSchema: z.ZodType< customFields: z.array(CustomField$outboundSchema).optional(), passThrough: z.array(PassThroughBody$outboundSchema).optional(), accountingPeriod: z.nullable(z.string()).optional(), + attachments: z.array(z.nullable(LinkedAttachment$outboundSchema)).optional(), }).transform((v) => { return remap$(v, { + displayId: "display_id", billNumber: "bill_number", companyId: "company_id", + departmentId: "department_id", currencyRate: "currency_rate", taxInclusive: "tax_inclusive", billDate: "bill_date", @@ -803,6 +974,11 @@ export const BillInput$outboundSchema: z.ZodType< accountingByRow: "accounting_by_row", bankAccount: "bank_account", discountPercentage: "discount_percentage", + templateId: "template_id", + approvedBy: "approved_by", + amortizationType: "amortization_type", + taxMethod: "tax_method", + documentReceived: "document_received", sourceDocumentUrl: "source_document_url", trackingCategories: "tracking_categories", rowVersion: "row_version", diff --git a/src/models/components/billlineitem.ts b/src/models/components/billlineitem.ts index c36b8d93..94432198 100644 --- a/src/models/components/billlineitem.ts +++ b/src/models/components/billlineitem.ts @@ -62,6 +62,12 @@ import { LinkedTrackingCategory$Outbound, LinkedTrackingCategory$outboundSchema, } from "./linkedtrackingcategory.js"; +import { + LinkedWorktag, + LinkedWorktag$inboundSchema, + LinkedWorktag$Outbound, + LinkedWorktag$outboundSchema, +} from "./linkedworktag.js"; import { Rebilling, Rebilling$inboundSchema, @@ -145,6 +151,38 @@ export type BillLineItem = { * ID of the category of the line item */ categoryId?: string | null | undefined; + /** + * ID of the shipping of the line item + */ + shippingId?: string | null | undefined; + /** + * Memo + */ + memo?: string | null | undefined; + /** + * Whether the line item is prepaid + */ + prepaid?: boolean | null | undefined; + /** + * Tax applicable on + */ + taxApplicableOn?: string | null | undefined; + /** + * Tax recoverability + */ + taxRecoverability?: string | null | undefined; + /** + * Method of tax calculation + */ + taxMethod?: string | null | undefined; + /** + * Retention amount + */ + retentionAmount?: number | null | undefined; + /** + * Payment amount + */ + paymentAmount?: number | null | undefined; item?: LinkedInvoiceItem | undefined; taxRate?: LinkedTaxRate | undefined; ledgerAccount?: LinkedLedgerAccount | null | undefined; @@ -181,6 +219,10 @@ export type BillLineItem = { * The date and time when the object was last updated. */ updatedAt?: Date | null | undefined; + /** + * A list of linked worktags. This is only supported for Workday. + */ + worktags?: Array | undefined; }; export type BillLineItemInput = { @@ -242,6 +284,38 @@ export type BillLineItemInput = { * ID of the category of the line item */ categoryId?: string | null | undefined; + /** + * ID of the shipping of the line item + */ + shippingId?: string | null | undefined; + /** + * Memo + */ + memo?: string | null | undefined; + /** + * Whether the line item is prepaid + */ + prepaid?: boolean | null | undefined; + /** + * Tax applicable on + */ + taxApplicableOn?: string | null | undefined; + /** + * Tax recoverability + */ + taxRecoverability?: string | null | undefined; + /** + * Method of tax calculation + */ + taxMethod?: string | null | undefined; + /** + * Retention amount + */ + retentionAmount?: number | null | undefined; + /** + * Payment amount + */ + paymentAmount?: number | null | undefined; item?: LinkedInvoiceItem | undefined; taxRate?: LinkedTaxRateInput | undefined; ledgerAccount?: LinkedLedgerAccountInput | null | undefined; @@ -262,6 +336,10 @@ export type BillLineItemInput = { * 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. */ rowVersion?: string | null | undefined; + /** + * A list of linked worktags. This is only supported for Workday. + */ + worktags?: Array | undefined; }; /** @internal */ @@ -308,6 +386,14 @@ export const BillLineItem$inboundSchema: z.ZodType< department_id: z.nullable(z.string()).optional(), subsidiary_id: z.nullable(z.string()).optional(), category_id: z.nullable(z.string()).optional(), + shipping_id: z.nullable(z.string()).optional(), + memo: z.nullable(z.string()).optional(), + prepaid: z.nullable(z.boolean()).optional(), + tax_applicable_on: z.nullable(z.string()).optional(), + tax_recoverability: z.nullable(z.string()).optional(), + tax_method: z.nullable(z.string()).optional(), + retention_amount: z.nullable(z.number()).optional(), + payment_amount: z.nullable(z.number()).optional(), item: LinkedInvoiceItem$inboundSchema.optional(), tax_rate: LinkedTaxRate$inboundSchema.optional(), ledger_account: z.nullable(LinkedLedgerAccount$inboundSchema).optional(), @@ -326,6 +412,7 @@ export const BillLineItem$inboundSchema: z.ZodType< updated_at: z.nullable( z.string().datetime({ offset: true }).transform(v => new Date(v)), ).optional(), + worktags: z.array(z.nullable(LinkedWorktag$inboundSchema)).optional(), }).transform((v) => { return remap$(v, { "row_id": "rowId", @@ -340,6 +427,12 @@ export const BillLineItem$inboundSchema: z.ZodType< "department_id": "departmentId", "subsidiary_id": "subsidiaryId", "category_id": "categoryId", + "shipping_id": "shippingId", + "tax_applicable_on": "taxApplicableOn", + "tax_recoverability": "taxRecoverability", + "tax_method": "taxMethod", + "retention_amount": "retentionAmount", + "payment_amount": "paymentAmount", "tax_rate": "taxRate", "ledger_account": "ledgerAccount", "purchase_order": "purchaseOrder", @@ -371,6 +464,14 @@ export type BillLineItem$Outbound = { department_id?: string | null | undefined; subsidiary_id?: string | null | undefined; category_id?: string | null | undefined; + shipping_id?: string | null | undefined; + memo?: string | null | undefined; + prepaid?: boolean | null | undefined; + tax_applicable_on?: string | null | undefined; + tax_recoverability?: string | null | undefined; + tax_method?: string | null | undefined; + retention_amount?: number | null | undefined; + payment_amount?: number | null | undefined; item?: LinkedInvoiceItem$Outbound | undefined; tax_rate?: LinkedTaxRate$Outbound | undefined; ledger_account?: LinkedLedgerAccount$Outbound | null | undefined; @@ -386,6 +487,7 @@ export type BillLineItem$Outbound = { created_by?: string | null | undefined; created_at?: string | null | undefined; updated_at?: string | null | undefined; + worktags?: Array | undefined; }; /** @internal */ @@ -411,6 +513,14 @@ export const BillLineItem$outboundSchema: z.ZodType< departmentId: z.nullable(z.string()).optional(), subsidiaryId: z.nullable(z.string()).optional(), categoryId: z.nullable(z.string()).optional(), + shippingId: z.nullable(z.string()).optional(), + memo: z.nullable(z.string()).optional(), + prepaid: z.nullable(z.boolean()).optional(), + taxApplicableOn: z.nullable(z.string()).optional(), + taxRecoverability: z.nullable(z.string()).optional(), + taxMethod: z.nullable(z.string()).optional(), + retentionAmount: z.nullable(z.number()).optional(), + paymentAmount: z.nullable(z.number()).optional(), item: LinkedInvoiceItem$outboundSchema.optional(), taxRate: LinkedTaxRate$outboundSchema.optional(), ledgerAccount: z.nullable(LinkedLedgerAccount$outboundSchema).optional(), @@ -425,6 +535,7 @@ export const BillLineItem$outboundSchema: z.ZodType< createdBy: z.nullable(z.string()).optional(), createdAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), updatedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), + worktags: z.array(z.nullable(LinkedWorktag$outboundSchema)).optional(), }).transform((v) => { return remap$(v, { rowId: "row_id", @@ -439,6 +550,12 @@ export const BillLineItem$outboundSchema: z.ZodType< departmentId: "department_id", subsidiaryId: "subsidiary_id", categoryId: "category_id", + shippingId: "shipping_id", + taxApplicableOn: "tax_applicable_on", + taxRecoverability: "tax_recoverability", + taxMethod: "tax_method", + retentionAmount: "retention_amount", + paymentAmount: "payment_amount", taxRate: "tax_rate", ledgerAccount: "ledger_account", purchaseOrder: "purchase_order", @@ -500,6 +617,14 @@ export const BillLineItemInput$inboundSchema: z.ZodType< department_id: z.nullable(z.string()).optional(), subsidiary_id: z.nullable(z.string()).optional(), category_id: z.nullable(z.string()).optional(), + shipping_id: z.nullable(z.string()).optional(), + memo: z.nullable(z.string()).optional(), + prepaid: z.nullable(z.boolean()).optional(), + tax_applicable_on: z.nullable(z.string()).optional(), + tax_recoverability: z.nullable(z.string()).optional(), + tax_method: z.nullable(z.string()).optional(), + retention_amount: z.nullable(z.number()).optional(), + payment_amount: z.nullable(z.number()).optional(), item: LinkedInvoiceItem$inboundSchema.optional(), tax_rate: LinkedTaxRateInput$inboundSchema.optional(), ledger_account: z.nullable(LinkedLedgerAccountInput$inboundSchema).optional(), @@ -510,6 +635,7 @@ export const BillLineItemInput$inboundSchema: z.ZodType< customer: z.nullable(LinkedCustomerInput$inboundSchema).optional(), rebilling: z.nullable(Rebilling$inboundSchema).optional(), row_version: z.nullable(z.string()).optional(), + worktags: z.array(z.nullable(LinkedWorktag$inboundSchema)).optional(), }).transform((v) => { return remap$(v, { "row_id": "rowId", @@ -524,6 +650,12 @@ export const BillLineItemInput$inboundSchema: z.ZodType< "department_id": "departmentId", "subsidiary_id": "subsidiaryId", "category_id": "categoryId", + "shipping_id": "shippingId", + "tax_applicable_on": "taxApplicableOn", + "tax_recoverability": "taxRecoverability", + "tax_method": "taxMethod", + "retention_amount": "retentionAmount", + "payment_amount": "paymentAmount", "tax_rate": "taxRate", "ledger_account": "ledgerAccount", "purchase_order": "purchaseOrder", @@ -550,6 +682,14 @@ export type BillLineItemInput$Outbound = { department_id?: string | null | undefined; subsidiary_id?: string | null | undefined; category_id?: string | null | undefined; + shipping_id?: string | null | undefined; + memo?: string | null | undefined; + prepaid?: boolean | null | undefined; + tax_applicable_on?: string | null | undefined; + tax_recoverability?: string | null | undefined; + tax_method?: string | null | undefined; + retention_amount?: number | null | undefined; + payment_amount?: number | null | undefined; item?: LinkedInvoiceItem$Outbound | undefined; tax_rate?: LinkedTaxRateInput$Outbound | undefined; ledger_account?: LinkedLedgerAccountInput$Outbound | null | undefined; @@ -561,6 +701,7 @@ export type BillLineItemInput$Outbound = { customer?: LinkedCustomerInput$Outbound | null | undefined; rebilling?: Rebilling$Outbound | null | undefined; row_version?: string | null | undefined; + worktags?: Array | undefined; }; /** @internal */ @@ -585,6 +726,14 @@ export const BillLineItemInput$outboundSchema: z.ZodType< departmentId: z.nullable(z.string()).optional(), subsidiaryId: z.nullable(z.string()).optional(), categoryId: z.nullable(z.string()).optional(), + shippingId: z.nullable(z.string()).optional(), + memo: z.nullable(z.string()).optional(), + prepaid: z.nullable(z.boolean()).optional(), + taxApplicableOn: z.nullable(z.string()).optional(), + taxRecoverability: z.nullable(z.string()).optional(), + taxMethod: z.nullable(z.string()).optional(), + retentionAmount: z.nullable(z.number()).optional(), + paymentAmount: z.nullable(z.number()).optional(), item: LinkedInvoiceItem$outboundSchema.optional(), taxRate: LinkedTaxRateInput$outboundSchema.optional(), ledgerAccount: z.nullable(LinkedLedgerAccountInput$outboundSchema).optional(), @@ -595,6 +744,7 @@ export const BillLineItemInput$outboundSchema: z.ZodType< customer: z.nullable(LinkedCustomerInput$outboundSchema).optional(), rebilling: z.nullable(Rebilling$outboundSchema).optional(), rowVersion: z.nullable(z.string()).optional(), + worktags: z.array(z.nullable(LinkedWorktag$outboundSchema)).optional(), }).transform((v) => { return remap$(v, { rowId: "row_id", @@ -609,6 +759,12 @@ export const BillLineItemInput$outboundSchema: z.ZodType< departmentId: "department_id", subsidiaryId: "subsidiary_id", categoryId: "category_id", + shippingId: "shipping_id", + taxApplicableOn: "tax_applicable_on", + taxRecoverability: "tax_recoverability", + taxMethod: "tax_method", + retentionAmount: "retention_amount", + paymentAmount: "payment_amount", taxRate: "tax_rate", ledgerAccount: "ledger_account", purchaseOrder: "purchase_order", diff --git a/src/models/components/billpayment.ts b/src/models/components/billpayment.ts index d40bfdc8..858427d7 100644 --- a/src/models/components/billpayment.ts +++ b/src/models/components/billpayment.ts @@ -161,7 +161,7 @@ export type BillPayment = { */ supplier?: LinkedSupplier | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** @@ -282,7 +282,7 @@ export type BillPaymentInput = { */ supplier?: LinkedSupplierInput | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** diff --git a/src/models/components/creditnote.ts b/src/models/components/creditnote.ts index cf127faa..12fda7ff 100644 --- a/src/models/components/creditnote.ts +++ b/src/models/components/creditnote.ts @@ -123,9 +123,13 @@ export type CreditNote = { */ customer?: LinkedCustomer | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). */ @@ -240,9 +244,13 @@ export type CreditNoteInput = { */ customer?: LinkedCustomerInput | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). */ @@ -379,6 +387,7 @@ export const CreditNote$inboundSchema: z.ZodType< number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomer$inboundSchema).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), currency: z.nullable(Currency$inboundSchema).optional(), currency_rate: z.nullable(z.number()).optional(), tax_inclusive: z.nullable(z.boolean()).optional(), @@ -421,6 +430,7 @@ export const CreditNote$inboundSchema: z.ZodType< }).transform((v) => { return remap$(v, { "company_id": "companyId", + "department_id": "departmentId", "currency_rate": "currencyRate", "tax_inclusive": "taxInclusive", "sub_total": "subTotal", @@ -451,6 +461,7 @@ export type CreditNote$Outbound = { number?: string | null | undefined; customer?: LinkedCustomer$Outbound | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; currency?: string | null | undefined; currency_rate?: number | null | undefined; tax_inclusive?: boolean | null | undefined; @@ -496,6 +507,7 @@ export const CreditNote$outboundSchema: z.ZodType< number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomer$outboundSchema).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), currency: z.nullable(Currency$outboundSchema).optional(), currencyRate: z.nullable(z.number()).optional(), taxInclusive: z.nullable(z.boolean()).optional(), @@ -531,6 +543,7 @@ export const CreditNote$outboundSchema: z.ZodType< }).transform((v) => { return remap$(v, { companyId: "company_id", + departmentId: "department_id", currencyRate: "currency_rate", taxInclusive: "tax_inclusive", subTotal: "sub_total", @@ -591,6 +604,7 @@ export const CreditNoteInput$inboundSchema: z.ZodType< number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomerInput$inboundSchema).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), currency: z.nullable(Currency$inboundSchema).optional(), currency_rate: z.nullable(z.number()).optional(), tax_inclusive: z.nullable(z.boolean()).optional(), @@ -624,6 +638,7 @@ export const CreditNoteInput$inboundSchema: z.ZodType< }).transform((v) => { return remap$(v, { "company_id": "companyId", + "department_id": "departmentId", "currency_rate": "currencyRate", "tax_inclusive": "taxInclusive", "sub_total": "subTotal", @@ -648,6 +663,7 @@ export type CreditNoteInput$Outbound = { number?: string | null | undefined; customer?: LinkedCustomerInput$Outbound | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; currency?: string | null | undefined; currency_rate?: number | null | undefined; tax_inclusive?: boolean | null | undefined; @@ -687,6 +703,7 @@ export const CreditNoteInput$outboundSchema: z.ZodType< number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomerInput$outboundSchema).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), currency: z.nullable(Currency$outboundSchema).optional(), currencyRate: z.nullable(z.number()).optional(), taxInclusive: z.nullable(z.boolean()).optional(), @@ -717,6 +734,7 @@ export const CreditNoteInput$outboundSchema: z.ZodType< }).transform((v) => { return remap$(v, { companyId: "company_id", + departmentId: "department_id", currencyRate: "currency_rate", taxInclusive: "tax_inclusive", subTotal: "sub_total", diff --git a/src/models/components/customer.ts b/src/models/components/customer.ts index c2191eee..56483bb5 100644 --- a/src/models/components/customer.ts +++ b/src/models/components/customer.ts @@ -123,7 +123,7 @@ export type Customer = { */ companyName?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** @@ -228,7 +228,7 @@ export type CustomerInput = { */ companyName?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** diff --git a/src/models/components/expense.ts b/src/models/components/expense.ts index ca157ed2..84e515a2 100644 --- a/src/models/components/expense.ts +++ b/src/models/components/expense.ts @@ -101,7 +101,7 @@ export type Expense = { */ supplierId?: string | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** @@ -198,7 +198,7 @@ export type ExpenseInput = { */ supplierId?: string | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** diff --git a/src/models/components/index.ts b/src/models/components/index.ts index ddebfca1..501f2ed1 100644 --- a/src/models/components/index.ts +++ b/src/models/components/index.ts @@ -397,6 +397,7 @@ export * from "./leadssort.js"; export * from "./ledgeraccount.js"; export * from "./ledgeraccountsfilter.js"; export * from "./ledgeraccountssort.js"; +export * from "./linkedattachment.js"; export * from "./linkedconnectorresource.js"; export * from "./linkedcustomer.js"; export * from "./linkedcustomerinput.js"; @@ -413,6 +414,7 @@ export * from "./linkedsupplierinput.js"; export * from "./linkedtaxrate.js"; export * from "./linkedtaxrateinput.js"; export * from "./linkedtrackingcategory.js"; +export * from "./linkedworktag.js"; export * from "./links.js"; export * from "./log.js"; export * from "./logsfilter.js"; diff --git a/src/models/components/invoice.ts b/src/models/components/invoice.ts index c052a83a..2c196202 100644 --- a/src/models/components/invoice.ts +++ b/src/models/components/invoice.ts @@ -143,6 +143,10 @@ export type Invoice = { * The third-party API ID of original entity */ downstreamId?: string | null | undefined; + /** + * Id to be displayed. + */ + displayId?: string | null | undefined; /** * Invoice type */ @@ -156,9 +160,13 @@ export type Invoice = { */ customer?: LinkedCustomer | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * Date invoice was issued - YYYY-MM-DD. */ @@ -308,6 +316,10 @@ export type Invoice = { }; export type InvoiceInput = { + /** + * Id to be displayed. + */ + displayId?: string | null | undefined; /** * Invoice type */ @@ -321,9 +333,13 @@ export type InvoiceInput = { */ customer?: LinkedCustomerInput | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * Date invoice was issued - YYYY-MM-DD. */ @@ -567,10 +583,12 @@ export const Invoice$inboundSchema: z.ZodType = z.object({ id: z.string().optional(), downstream_id: z.nullable(z.string()).optional(), + display_id: z.nullable(z.string()).optional(), type: z.nullable(InvoiceType$inboundSchema).optional(), number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomer$inboundSchema).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), invoice_date: z.nullable(z.string().transform(v => new RFCDate(v))) .optional(), due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), @@ -626,7 +644,9 @@ export const Invoice$inboundSchema: z.ZodType = }).transform((v) => { return remap$(v, { "downstream_id": "downstreamId", + "display_id": "displayId", "company_id": "companyId", + "department_id": "departmentId", "invoice_date": "invoiceDate", "due_date": "dueDate", "po_number": "poNumber", @@ -666,10 +686,12 @@ export const Invoice$inboundSchema: z.ZodType = export type Invoice$Outbound = { id?: string | undefined; downstream_id?: string | null | undefined; + display_id?: string | null | undefined; type?: string | null | undefined; number?: string | null | undefined; customer?: LinkedCustomer$Outbound | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; invoice_date?: string | null | undefined; due_date?: string | null | undefined; terms?: string | null | undefined; @@ -727,10 +749,12 @@ export const Invoice$outboundSchema: z.ZodType< > = z.object({ id: z.string().optional(), downstreamId: z.nullable(z.string()).optional(), + displayId: z.nullable(z.string()).optional(), type: z.nullable(InvoiceType$outboundSchema).optional(), number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomer$outboundSchema).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), invoiceDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), dueDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) @@ -782,7 +806,9 @@ export const Invoice$outboundSchema: z.ZodType< }).transform((v) => { return remap$(v, { downstreamId: "downstream_id", + displayId: "display_id", companyId: "company_id", + departmentId: "department_id", invoiceDate: "invoice_date", dueDate: "due_date", poNumber: "po_number", @@ -851,10 +877,12 @@ export const InvoiceInput$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + display_id: z.nullable(z.string()).optional(), type: z.nullable(InvoiceType$inboundSchema).optional(), number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomerInput$inboundSchema).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), invoice_date: z.nullable(z.string().transform(v => new RFCDate(v))) .optional(), due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), @@ -899,7 +927,9 @@ export const InvoiceInput$inboundSchema: z.ZodType< pass_through: z.array(PassThroughBody$inboundSchema).optional(), }).transform((v) => { return remap$(v, { + "display_id": "displayId", "company_id": "companyId", + "department_id": "departmentId", "invoice_date": "invoiceDate", "due_date": "dueDate", "po_number": "poNumber", @@ -932,10 +962,12 @@ export const InvoiceInput$inboundSchema: z.ZodType< /** @internal */ export type InvoiceInput$Outbound = { + display_id?: string | null | undefined; type?: string | null | undefined; number?: string | null | undefined; customer?: LinkedCustomerInput$Outbound | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; invoice_date?: string | null | undefined; due_date?: string | null | undefined; terms?: string | null | undefined; @@ -986,10 +1018,12 @@ export const InvoiceInput$outboundSchema: z.ZodType< z.ZodTypeDef, InvoiceInput > = z.object({ + displayId: z.nullable(z.string()).optional(), type: z.nullable(InvoiceType$outboundSchema).optional(), number: z.nullable(z.string()).optional(), customer: z.nullable(LinkedCustomerInput$outboundSchema).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), invoiceDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), dueDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) @@ -1035,7 +1069,9 @@ export const InvoiceInput$outboundSchema: z.ZodType< passThrough: z.array(PassThroughBody$outboundSchema).optional(), }).transform((v) => { return remap$(v, { + displayId: "display_id", companyId: "company_id", + departmentId: "department_id", invoiceDate: "invoice_date", dueDate: "due_date", poNumber: "po_number", diff --git a/src/models/components/invoicelineitem.ts b/src/models/components/invoicelineitem.ts index 05e2d439..1546f8d3 100644 --- a/src/models/components/invoicelineitem.ts +++ b/src/models/components/invoicelineitem.ts @@ -50,6 +50,12 @@ import { LinkedTrackingCategory$Outbound, LinkedTrackingCategory$outboundSchema, } from "./linkedtrackingcategory.js"; +import { + LinkedWorktag, + LinkedWorktag$inboundSchema, + LinkedWorktag$Outbound, + LinkedWorktag$outboundSchema, +} from "./linkedworktag.js"; /** * Item type @@ -67,19 +73,6 @@ export const InvoiceLineItemType = { */ export type InvoiceLineItemType = ClosedEnum; -/** - * Budget of the line item - */ -export const Budget = { - OutOfBudget: "out_of_budget", - InBudget: "in_budget", - Other: "other", -} as const; -/** - * Budget of the line item - */ -export type Budget = ClosedEnum; - export type InvoiceLineItem = { /** * A unique identifier for an object. @@ -169,13 +162,9 @@ export type InvoiceLineItem = { */ taxMethod?: string | null | undefined; /** - * Budget of the line item + * Worktags of the line item. This is currently only supported in Workday. */ - budget?: Budget | null | undefined; - /** - * ID of the project of the line item - */ - projectId?: string | null | undefined; + worktags?: Array | undefined; taxRate?: LinkedTaxRate | undefined; /** * A list of linked tracking categories. @@ -294,13 +283,9 @@ export type InvoiceLineItemInput = { */ taxMethod?: string | null | undefined; /** - * Budget of the line item - */ - budget?: Budget | null | undefined; - /** - * ID of the project of the line item + * Worktags of the line item. This is currently only supported in Workday. */ - projectId?: string | null | undefined; + worktags?: Array | undefined; taxRate?: LinkedTaxRateInput | undefined; /** * A list of linked tracking categories. @@ -335,25 +320,6 @@ export namespace InvoiceLineItemType$ { export const outboundSchema = InvoiceLineItemType$outboundSchema; } -/** @internal */ -export const Budget$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(Budget); - -/** @internal */ -export const Budget$outboundSchema: z.ZodNativeEnum = - Budget$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Budget$ { - /** @deprecated use `Budget$inboundSchema` instead. */ - export const inboundSchema = Budget$inboundSchema; - /** @deprecated use `Budget$outboundSchema` instead. */ - export const outboundSchema = Budget$outboundSchema; -} - /** @internal */ export const InvoiceLineItem$inboundSchema: z.ZodType< InvoiceLineItem, @@ -384,8 +350,7 @@ export const InvoiceLineItem$inboundSchema: z.ZodType< tax_applicable_on: z.nullable(z.string()).optional(), tax_recoverability: z.nullable(z.string()).optional(), tax_method: z.nullable(z.string()).optional(), - budget: z.nullable(Budget$inboundSchema).optional(), - project_id: z.nullable(z.string()).optional(), + worktags: z.array(z.nullable(LinkedWorktag$inboundSchema)).optional(), tax_rate: LinkedTaxRate$inboundSchema.optional(), tracking_categories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$inboundSchema)), @@ -419,7 +384,6 @@ export const InvoiceLineItem$inboundSchema: z.ZodType< "tax_applicable_on": "taxApplicableOn", "tax_recoverability": "taxRecoverability", "tax_method": "taxMethod", - "project_id": "projectId", "tax_rate": "taxRate", "tracking_categories": "trackingCategories", "ledger_account": "ledgerAccount", @@ -458,8 +422,7 @@ export type InvoiceLineItem$Outbound = { tax_applicable_on?: string | null | undefined; tax_recoverability?: string | null | undefined; tax_method?: string | null | undefined; - budget?: string | null | undefined; - project_id?: string | null | undefined; + worktags?: Array | undefined; tax_rate?: LinkedTaxRate$Outbound | undefined; tracking_categories?: | Array @@ -504,8 +467,7 @@ export const InvoiceLineItem$outboundSchema: z.ZodType< taxApplicableOn: z.nullable(z.string()).optional(), taxRecoverability: z.nullable(z.string()).optional(), taxMethod: z.nullable(z.string()).optional(), - budget: z.nullable(Budget$outboundSchema).optional(), - projectId: z.nullable(z.string()).optional(), + worktags: z.array(z.nullable(LinkedWorktag$outboundSchema)).optional(), taxRate: LinkedTaxRate$outboundSchema.optional(), trackingCategories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$outboundSchema)), @@ -535,7 +497,6 @@ export const InvoiceLineItem$outboundSchema: z.ZodType< taxApplicableOn: "tax_applicable_on", taxRecoverability: "tax_recoverability", taxMethod: "tax_method", - projectId: "project_id", taxRate: "tax_rate", trackingCategories: "tracking_categories", ledgerAccount: "ledger_account", @@ -607,8 +568,7 @@ export const InvoiceLineItemInput$inboundSchema: z.ZodType< tax_applicable_on: z.nullable(z.string()).optional(), tax_recoverability: z.nullable(z.string()).optional(), tax_method: z.nullable(z.string()).optional(), - budget: z.nullable(Budget$inboundSchema).optional(), - project_id: z.nullable(z.string()).optional(), + worktags: z.array(z.nullable(LinkedWorktag$inboundSchema)).optional(), tax_rate: LinkedTaxRateInput$inboundSchema.optional(), tracking_categories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$inboundSchema)), @@ -634,7 +594,6 @@ export const InvoiceLineItemInput$inboundSchema: z.ZodType< "tax_applicable_on": "taxApplicableOn", "tax_recoverability": "taxRecoverability", "tax_method": "taxMethod", - "project_id": "projectId", "tax_rate": "taxRate", "tracking_categories": "trackingCategories", "ledger_account": "ledgerAccount", @@ -669,8 +628,7 @@ export type InvoiceLineItemInput$Outbound = { tax_applicable_on?: string | null | undefined; tax_recoverability?: string | null | undefined; tax_method?: string | null | undefined; - budget?: string | null | undefined; - project_id?: string | null | undefined; + worktags?: Array | undefined; tax_rate?: LinkedTaxRateInput$Outbound | undefined; tracking_categories?: | Array @@ -711,8 +669,7 @@ export const InvoiceLineItemInput$outboundSchema: z.ZodType< taxApplicableOn: z.nullable(z.string()).optional(), taxRecoverability: z.nullable(z.string()).optional(), taxMethod: z.nullable(z.string()).optional(), - budget: z.nullable(Budget$outboundSchema).optional(), - projectId: z.nullable(z.string()).optional(), + worktags: z.array(z.nullable(LinkedWorktag$outboundSchema)).optional(), taxRate: LinkedTaxRateInput$outboundSchema.optional(), trackingCategories: z.nullable( z.array(z.nullable(LinkedTrackingCategory$outboundSchema)), @@ -738,7 +695,6 @@ export const InvoiceLineItemInput$outboundSchema: z.ZodType< taxApplicableOn: "tax_applicable_on", taxRecoverability: "tax_recoverability", taxMethod: "tax_method", - projectId: "project_id", taxRate: "tax_rate", trackingCategories: "tracking_categories", ledgerAccount: "ledger_account", diff --git a/src/models/components/journalentry.ts b/src/models/components/journalentry.ts index 9b1b05ad..8c08ce57 100644 --- a/src/models/components/journalentry.ts +++ b/src/models/components/journalentry.ts @@ -78,7 +78,7 @@ export type JournalEntry = { */ currency?: Currency | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** @@ -166,7 +166,7 @@ export type JournalEntryInput = { */ currency?: Currency | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** diff --git a/src/models/components/linkedattachment.ts b/src/models/components/linkedattachment.ts new file mode 100644 index 00000000..29675d2f --- /dev/null +++ b/src/models/components/linkedattachment.ts @@ -0,0 +1,115 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../lib/primitives.js"; +import { safeParse } from "../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type LinkedAttachment = { + /** + * The name of the file + */ + name?: string | null | undefined; + /** + * The MIME type of the file. + */ + mimeType?: string | null | undefined; + /** + * Whether the file is c ompressed. + */ + isCompressed?: boolean | null | undefined; + /** + * The encoding of the file. + */ + encoding?: string | null | undefined; + /** + * The content of the file. + */ + content?: string | null | undefined; + /** + * The notes of the file. + */ + notes?: string | null | undefined; +}; + +/** @internal */ +export const LinkedAttachment$inboundSchema: z.ZodType< + LinkedAttachment, + z.ZodTypeDef, + unknown +> = z.object({ + name: z.nullable(z.string()).optional(), + mime_type: z.nullable(z.string()).optional(), + is_compressed: z.nullable(z.boolean()).optional(), + encoding: z.nullable(z.string()).optional(), + content: z.nullable(z.string()).optional(), + notes: z.nullable(z.string()).optional(), +}).transform((v) => { + return remap$(v, { + "mime_type": "mimeType", + "is_compressed": "isCompressed", + }); +}); + +/** @internal */ +export type LinkedAttachment$Outbound = { + name?: string | null | undefined; + mime_type?: string | null | undefined; + is_compressed?: boolean | null | undefined; + encoding?: string | null | undefined; + content?: string | null | undefined; + notes?: string | null | undefined; +}; + +/** @internal */ +export const LinkedAttachment$outboundSchema: z.ZodType< + LinkedAttachment$Outbound, + z.ZodTypeDef, + LinkedAttachment +> = z.object({ + name: z.nullable(z.string()).optional(), + mimeType: z.nullable(z.string()).optional(), + isCompressed: z.nullable(z.boolean()).optional(), + encoding: z.nullable(z.string()).optional(), + content: z.nullable(z.string()).optional(), + notes: z.nullable(z.string()).optional(), +}).transform((v) => { + return remap$(v, { + mimeType: "mime_type", + isCompressed: "is_compressed", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace LinkedAttachment$ { + /** @deprecated use `LinkedAttachment$inboundSchema` instead. */ + export const inboundSchema = LinkedAttachment$inboundSchema; + /** @deprecated use `LinkedAttachment$outboundSchema` instead. */ + export const outboundSchema = LinkedAttachment$outboundSchema; + /** @deprecated use `LinkedAttachment$Outbound` instead. */ + export type Outbound = LinkedAttachment$Outbound; +} + +export function linkedAttachmentToJSON( + linkedAttachment: LinkedAttachment, +): string { + return JSON.stringify( + LinkedAttachment$outboundSchema.parse(linkedAttachment), + ); +} + +export function linkedAttachmentFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => LinkedAttachment$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'LinkedAttachment' from JSON`, + ); +} diff --git a/src/models/components/linkedworktag.ts b/src/models/components/linkedworktag.ts new file mode 100644 index 00000000..f653fe1c --- /dev/null +++ b/src/models/components/linkedworktag.ts @@ -0,0 +1,72 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type LinkedWorktag = { + /** + * The unique identifier for the worktag. + */ + id?: string | undefined; + /** + * The value of the worktag. + */ + value?: string | null | undefined; +}; + +/** @internal */ +export const LinkedWorktag$inboundSchema: z.ZodType< + LinkedWorktag, + z.ZodTypeDef, + unknown +> = z.object({ + id: z.string().optional(), + value: z.nullable(z.string()).optional(), +}); + +/** @internal */ +export type LinkedWorktag$Outbound = { + id?: string | undefined; + value?: string | null | undefined; +}; + +/** @internal */ +export const LinkedWorktag$outboundSchema: z.ZodType< + LinkedWorktag$Outbound, + z.ZodTypeDef, + LinkedWorktag +> = z.object({ + id: z.string().optional(), + value: z.nullable(z.string()).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace LinkedWorktag$ { + /** @deprecated use `LinkedWorktag$inboundSchema` instead. */ + export const inboundSchema = LinkedWorktag$inboundSchema; + /** @deprecated use `LinkedWorktag$outboundSchema` instead. */ + export const outboundSchema = LinkedWorktag$outboundSchema; + /** @deprecated use `LinkedWorktag$Outbound` instead. */ + export type Outbound = LinkedWorktag$Outbound; +} + +export function linkedWorktagToJSON(linkedWorktag: LinkedWorktag): string { + return JSON.stringify(LinkedWorktag$outboundSchema.parse(linkedWorktag)); +} + +export function linkedWorktagFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => LinkedWorktag$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'LinkedWorktag' from JSON`, + ); +} diff --git a/src/models/components/payment.ts b/src/models/components/payment.ts index cc380c64..b2c583af 100644 --- a/src/models/components/payment.ts +++ b/src/models/components/payment.ts @@ -130,7 +130,7 @@ export type Payment = { */ supplier?: DeprecatedLinkedSupplier | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** diff --git a/src/models/components/paymentinput.ts b/src/models/components/paymentinput.ts index 479187fa..54266270 100644 --- a/src/models/components/paymentinput.ts +++ b/src/models/components/paymentinput.ts @@ -122,7 +122,7 @@ export type PaymentInput = { */ supplier?: DeprecatedLinkedSupplierInput | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** diff --git a/src/models/components/purchaseorder.ts b/src/models/components/purchaseorder.ts index b147a33d..2bae270f 100644 --- a/src/models/components/purchaseorder.ts +++ b/src/models/components/purchaseorder.ts @@ -92,7 +92,7 @@ export type PurchaseOrderStatus = ClosedEnum; /** * Type of amortization */ -export const AmortizationType = { +export const PurchaseOrderAmortizationType = { Manual: "manual", Receipt: "receipt", Schedule: "schedule", @@ -101,7 +101,9 @@ export const AmortizationType = { /** * Type of amortization */ -export type AmortizationType = ClosedEnum; +export type PurchaseOrderAmortizationType = ClosedEnum< + typeof PurchaseOrderAmortizationType +>; export type PurchaseOrder = { /** @@ -129,9 +131,13 @@ export type PurchaseOrder = { */ subsidiaryId?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; status?: PurchaseOrderStatus | null | undefined; /** * Date purchase order was issued - YYYY-MM-DD. @@ -201,7 +207,7 @@ export type PurchaseOrder = { /** * Type of amortization */ - amortizationType?: AmortizationType | null | undefined; + amortizationType?: PurchaseOrderAmortizationType | null | undefined; /** * Applicable tax id/code override if tax is not supplied on a line item basis. */ @@ -283,9 +289,13 @@ export type PurchaseOrderInput = { */ subsidiaryId?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; status?: PurchaseOrderStatus | null | undefined; /** * Date purchase order was issued - YYYY-MM-DD. @@ -355,7 +365,7 @@ export type PurchaseOrderInput = { /** * Type of amortization */ - amortizationType?: AmortizationType | null | undefined; + amortizationType?: PurchaseOrderAmortizationType | null | undefined; /** * Applicable tax id/code override if tax is not supplied on a line item basis. */ @@ -421,24 +431,24 @@ export namespace PurchaseOrderStatus$ { } /** @internal */ -export const AmortizationType$inboundSchema: z.ZodNativeEnum< - typeof AmortizationType -> = z.nativeEnum(AmortizationType); +export const PurchaseOrderAmortizationType$inboundSchema: z.ZodNativeEnum< + typeof PurchaseOrderAmortizationType +> = z.nativeEnum(PurchaseOrderAmortizationType); /** @internal */ -export const AmortizationType$outboundSchema: z.ZodNativeEnum< - typeof AmortizationType -> = AmortizationType$inboundSchema; +export const PurchaseOrderAmortizationType$outboundSchema: z.ZodNativeEnum< + typeof PurchaseOrderAmortizationType +> = PurchaseOrderAmortizationType$inboundSchema; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace AmortizationType$ { - /** @deprecated use `AmortizationType$inboundSchema` instead. */ - export const inboundSchema = AmortizationType$inboundSchema; - /** @deprecated use `AmortizationType$outboundSchema` instead. */ - export const outboundSchema = AmortizationType$outboundSchema; +export namespace PurchaseOrderAmortizationType$ { + /** @deprecated use `PurchaseOrderAmortizationType$inboundSchema` instead. */ + export const inboundSchema = PurchaseOrderAmortizationType$inboundSchema; + /** @deprecated use `PurchaseOrderAmortizationType$outboundSchema` instead. */ + export const outboundSchema = PurchaseOrderAmortizationType$outboundSchema; } /** @internal */ @@ -454,6 +464,7 @@ export const PurchaseOrder$inboundSchema: z.ZodType< supplier: z.nullable(LinkedSupplier$inboundSchema).optional(), subsidiary_id: z.nullable(z.string()).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), status: z.nullable(PurchaseOrderStatus$inboundSchema).optional(), issued_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), delivery_date: z.nullable(z.string().transform(v => new RFCDate(v))) @@ -477,7 +488,8 @@ export const PurchaseOrder$inboundSchema: z.ZodType< due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), payment_method: z.nullable(z.string()).optional(), terms: z.nullable(z.string()).optional(), - amortization_type: z.nullable(AmortizationType$inboundSchema).optional(), + amortization_type: z.nullable(PurchaseOrderAmortizationType$inboundSchema) + .optional(), tax_code: z.nullable(z.string()).optional(), tax_method: z.nullable(z.string()).optional(), issued_method: z.nullable(z.string()).optional(), @@ -506,6 +518,7 @@ export const PurchaseOrder$inboundSchema: z.ZodType< "po_number": "poNumber", "subsidiary_id": "subsidiaryId", "company_id": "companyId", + "department_id": "departmentId", "issued_date": "issuedDate", "delivery_date": "deliveryDate", "expected_arrival_date": "expectedArrivalDate", @@ -549,6 +562,7 @@ export type PurchaseOrder$Outbound = { supplier?: LinkedSupplier$Outbound | null | undefined; subsidiary_id?: string | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; status?: string | null | undefined; issued_date?: string | null | undefined; delivery_date?: string | null | undefined; @@ -605,6 +619,7 @@ export const PurchaseOrder$outboundSchema: z.ZodType< supplier: z.nullable(LinkedSupplier$outboundSchema).optional(), subsidiaryId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), status: z.nullable(PurchaseOrderStatus$outboundSchema).optional(), issuedDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), @@ -631,7 +646,8 @@ export const PurchaseOrder$outboundSchema: z.ZodType< .optional(), paymentMethod: z.nullable(z.string()).optional(), terms: z.nullable(z.string()).optional(), - amortizationType: z.nullable(AmortizationType$outboundSchema).optional(), + amortizationType: z.nullable(PurchaseOrderAmortizationType$outboundSchema) + .optional(), taxCode: z.nullable(z.string()).optional(), taxMethod: z.nullable(z.string()).optional(), issuedMethod: z.nullable(z.string()).optional(), @@ -656,6 +672,7 @@ export const PurchaseOrder$outboundSchema: z.ZodType< poNumber: "po_number", subsidiaryId: "subsidiary_id", companyId: "company_id", + departmentId: "department_id", issuedDate: "issued_date", deliveryDate: "delivery_date", expectedArrivalDate: "expected_arrival_date", @@ -728,6 +745,7 @@ export const PurchaseOrderInput$inboundSchema: z.ZodType< supplier: z.nullable(LinkedSupplierInput$inboundSchema).optional(), subsidiary_id: z.nullable(z.string()).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), status: z.nullable(PurchaseOrderStatus$inboundSchema).optional(), issued_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), delivery_date: z.nullable(z.string().transform(v => new RFCDate(v))) @@ -751,7 +769,8 @@ export const PurchaseOrderInput$inboundSchema: z.ZodType< due_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), payment_method: z.nullable(z.string()).optional(), terms: z.nullable(z.string()).optional(), - amortization_type: z.nullable(AmortizationType$inboundSchema).optional(), + amortization_type: z.nullable(PurchaseOrderAmortizationType$inboundSchema) + .optional(), tax_code: z.nullable(z.string()).optional(), tax_method: z.nullable(z.string()).optional(), issued_method: z.nullable(z.string()).optional(), @@ -770,6 +789,7 @@ export const PurchaseOrderInput$inboundSchema: z.ZodType< "po_number": "poNumber", "subsidiary_id": "subsidiaryId", "company_id": "companyId", + "department_id": "departmentId", "issued_date": "issuedDate", "delivery_date": "deliveryDate", "expected_arrival_date": "expectedArrivalDate", @@ -806,6 +826,7 @@ export type PurchaseOrderInput$Outbound = { supplier?: LinkedSupplierInput$Outbound | null | undefined; subsidiary_id?: string | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; status?: string | null | undefined; issued_date?: string | null | undefined; delivery_date?: string | null | undefined; @@ -855,6 +876,7 @@ export const PurchaseOrderInput$outboundSchema: z.ZodType< supplier: z.nullable(LinkedSupplierInput$outboundSchema).optional(), subsidiaryId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), status: z.nullable(PurchaseOrderStatus$outboundSchema).optional(), issuedDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), @@ -881,7 +903,8 @@ export const PurchaseOrderInput$outboundSchema: z.ZodType< .optional(), paymentMethod: z.nullable(z.string()).optional(), terms: z.nullable(z.string()).optional(), - amortizationType: z.nullable(AmortizationType$outboundSchema).optional(), + amortizationType: z.nullable(PurchaseOrderAmortizationType$outboundSchema) + .optional(), taxCode: z.nullable(z.string()).optional(), taxMethod: z.nullable(z.string()).optional(), issuedMethod: z.nullable(z.string()).optional(), @@ -900,6 +923,7 @@ export const PurchaseOrderInput$outboundSchema: z.ZodType< poNumber: "po_number", subsidiaryId: "subsidiary_id", companyId: "company_id", + departmentId: "department_id", issuedDate: "issued_date", deliveryDate: "delivery_date", expectedArrivalDate: "expected_arrival_date", diff --git a/src/models/components/quote.ts b/src/models/components/quote.ts index 9dc7e652..181813f9 100644 --- a/src/models/components/quote.ts +++ b/src/models/components/quote.ts @@ -105,9 +105,13 @@ export type Quote = { */ salesOrderId?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * The unique identifier for the linked project. */ @@ -228,9 +232,13 @@ export type QuoteInput = { */ salesOrderId?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; + /** + * The ID of the department + */ + departmentId?: string | null | undefined; /** * The unique identifier for the linked project. */ @@ -350,6 +358,7 @@ export const Quote$inboundSchema: z.ZodType = z invoice_id: z.string().optional(), sales_order_id: z.nullable(z.string()).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), project_id: z.string().optional(), quote_date: z.nullable(z.string().transform(v => new RFCDate(v))) .optional(), @@ -393,6 +402,7 @@ export const Quote$inboundSchema: z.ZodType = z "invoice_id": "invoiceId", "sales_order_id": "salesOrderId", "company_id": "companyId", + "department_id": "departmentId", "project_id": "projectId", "quote_date": "quoteDate", "expiry_date": "expiryDate", @@ -429,6 +439,7 @@ export type Quote$Outbound = { invoice_id?: string | undefined; sales_order_id?: string | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; project_id?: string | undefined; quote_date?: string | null | undefined; expiry_date?: string | null | undefined; @@ -476,6 +487,7 @@ export const Quote$outboundSchema: z.ZodType< invoiceId: z.string().optional(), salesOrderId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), projectId: z.string().optional(), quoteDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), @@ -515,6 +527,7 @@ export const Quote$outboundSchema: z.ZodType< invoiceId: "invoice_id", salesOrderId: "sales_order_id", companyId: "company_id", + departmentId: "department_id", projectId: "project_id", quoteDate: "quote_date", expiryDate: "expiry_date", @@ -579,6 +592,7 @@ export const QuoteInput$inboundSchema: z.ZodType< customer: z.nullable(LinkedCustomerInput$inboundSchema).optional(), sales_order_id: z.nullable(z.string()).optional(), company_id: z.nullable(z.string()).optional(), + department_id: z.nullable(z.string()).optional(), project_id: z.string().optional(), quote_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), expiry_date: z.nullable(z.string().transform(v => new RFCDate(v))).optional(), @@ -610,6 +624,7 @@ export const QuoteInput$inboundSchema: z.ZodType< return remap$(v, { "sales_order_id": "salesOrderId", "company_id": "companyId", + "department_id": "departmentId", "project_id": "projectId", "quote_date": "quoteDate", "expiry_date": "expiryDate", @@ -639,6 +654,7 @@ export type QuoteInput$Outbound = { customer?: LinkedCustomerInput$Outbound | null | undefined; sales_order_id?: string | null | undefined; company_id?: string | null | undefined; + department_id?: string | null | undefined; project_id?: string | undefined; quote_date?: string | null | undefined; expiry_date?: string | null | undefined; @@ -679,6 +695,7 @@ export const QuoteInput$outboundSchema: z.ZodType< customer: z.nullable(LinkedCustomerInput$outboundSchema).optional(), salesOrderId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), + departmentId: z.nullable(z.string()).optional(), projectId: z.string().optional(), quoteDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString())) .optional(), @@ -712,6 +729,7 @@ export const QuoteInput$outboundSchema: z.ZodType< return remap$(v, { salesOrderId: "sales_order_id", companyId: "company_id", + departmentId: "department_id", projectId: "project_id", quoteDate: "quote_date", expiryDate: "expiry_date", diff --git a/src/models/components/supplier.ts b/src/models/components/supplier.ts index b6942f5b..1ad2ce79 100644 --- a/src/models/components/supplier.ts +++ b/src/models/components/supplier.ts @@ -117,7 +117,7 @@ export type Supplier = { */ companyName?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /** @@ -226,7 +226,7 @@ export type SupplierInput = { */ companyName?: string | null | undefined; /** - * The company or subsidiary id the transaction belongs to + * The company ID the transaction belongs to */ companyId?: string | null | undefined; /**