Skip to content

README.md

Latest commit

 

History

History
915 lines (829 loc) · 185 KB

README.md

File metadata and controls

915 lines (829 loc) · 185 KB

Invoices

(accounting.invoices)

Overview

Available Operations

list

List Invoices

Example Usage

import apideck_unify
from apideck_unify import Apideck
from apideck_unify.utils import parse_datetime
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.invoices.list(raw=False, service_id="salesforce", company_id="12345", limit=20, filter_={
        "updated_since": parse_datetime("2020-09-30T07:43:32.000Z"),
        "created_since": parse_datetime("2020-09-30T07:43:32.000Z"),
        "number": "OIT00546",
    }, sort={
        "by": apideck_unify.InvoicesSortBy.UPDATED_AT,
        "direction": apideck_unify.SortDirection.DESC,
    }, pass_through={
        "search": "San Francisco",
    }, fields="id,updated_at")

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description Example
raw Optional[bool] ➖ Include raw response. Mostly used for debugging purposes
consumer_id Optional[str] ➖ ID of the consumer which you want to get or push data from test-consumer
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
service_id Optional[str] ➖ Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. salesforce
company_id Optional[str] ➖ The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. 12345
cursor OptionalNullable[str] ➖ Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
limit Optional[int] ➖ Number of results to return. Minimum 1, Maximum 200, Default 20
filter_ Optional[models.InvoicesFilter] ➖ Apply filters {
"updated_since": "2020-09-30T07:43:32.000Z",
"created_since": "2020-09-30T07:43:32.000Z",
"number": "OIT00546",
"supplier_id": "123",
"id_since": "1"
}
sort Optional[models.InvoicesSort] ➖ Apply sorting {
"by": "updated_at",
"direction": "desc"
}
pass_through Dict[str, Any] ➖ Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads {
"search": "San Francisco"
}
fields OptionalNullable[str] ➖ The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.		 id,updated_at
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AccountingInvoicesAllResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.UnprocessableResponse 422 application/json
models.APIError 4XX, 5XX */*

create

Create Invoice

Example Usage

import apideck_unify
from apideck_unify import Apideck
from apideck_unify.utils import parse_datetime
from datetime import date
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.invoices.create(raw=False, service_id="salesforce", company_id_param="12345", display_id="123456", type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={
        "id": "12345",
        "display_name": "Windsurf Shop",
        "email": "boring@boring.com",
    }, company_id="12345", location_id="12345", department_id="12345", invoice_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-09-30"), terms="Net 30 days", terms_id="12345", po_number="90000117", reference="123456", status=apideck_unify.InvoiceStatus.DRAFT, invoice_sent=True, currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", discount_percentage=5.5, discount_amount=25, total=27500, balance=27500, deposit=0, customer_memo="Thank you for your business and have a great day!", tracking_categories=[
        {
            "id": "123456",
            "name": "New York",
        },
        {
            "id": "123456",
            "name": "New York",
        },
        {
            "id": "123456",
            "name": "New York",
        },
    ], line_items=[
        {
            "id": "12345",
            "row_id": "12345",
            "code": "120-C",
            "line_number": 1,
            "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
            "type": apideck_unify.InvoiceLineItemType.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": {

                    },
                },
            ],
            "row_version": "1-12345",
        },
        {
            "id": "12345",
            "row_id": "12345",
            "code": "120-C",
            "line_number": 1,
            "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
            "type": apideck_unify.InvoiceLineItemType.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": {

                    },
                },
            ],
            "row_version": "1-12345",
        },
    ], billing_address={
        "id": "123",
        "type": apideck_unify.Type.PRIMARY,
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-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": apideck_unify.Type.PRIMARY,
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-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_": parse_datetime("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": apideck_unify.AccountType.CREDIT_CARD,
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": apideck_unify.Currency.USD,
    }, ledger_account={
        "id": "123456",
        "nominal_code": "N091",
        "code": "453",
    }, custom_fields=[
        {
            "id": "2389328923893298",
            "name": "employee_level",
            "description": "Employee Level",
            "value": {

            },
        },
    ], row_version="1-12345", pass_through=[
        {
            "service_id": "<id>",
            "extend_paths": [
                {
                    "path": "$.nested.property",
                    "value": {
                        "TaxClassificationRef": {
                            "value": "EUC-99990201-V1-00020000",
                        },
                    },
                },
                {
                    "path": "$.nested.property",
                    "value": {
                        "TaxClassificationRef": {
                            "value": "EUC-99990201-V1-00020000",
                        },
                    },
                },
            ],
        },
        {
            "service_id": "<id>",
            "extend_paths": [
                {
                    "path": "$.nested.property",
                    "value": {
                        "TaxClassificationRef": {
                            "value": "EUC-99990201-V1-00020000",
                        },
                    },
                },
                {
                    "path": "$.nested.property",
                    "value": {
                        "TaxClassificationRef": {
                            "value": "EUC-99990201-V1-00020000",
                        },
                    },
                },
            ],
        },
    ])

    assert res.create_invoice_response is not None

    # Handle response
    print(res.create_invoice_response)

Parameters

Parameter Type Required Description Example
raw Optional[bool] ➖ Include raw response. Mostly used for debugging purposes
consumer_id Optional[str] ➖ ID of the consumer which you want to get or push data from test-consumer
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
service_id Optional[str] ➖ Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. salesforce
company_id_param Optional[str] ➖ The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. 12345
display_id OptionalNullable[str] ➖ Id to be displayed. 123456
type OptionalNullable[models.InvoiceType] ➖ Invoice type service
number OptionalNullable[str] ➖ Invoice number. OIT00546
customer OptionalNullable[models.LinkedCustomerInput] ➖ The customer this entity is linked to.
company_id OptionalNullable[str] ➖ The company ID the transaction belongs to 12345
location_id OptionalNullable[str] ➖ The ID of the location 12345
department_id OptionalNullable[str] ➖ The ID of the department 12345
invoice_date datetime ➖ Date invoice was issued - YYYY-MM-DD. 2020-09-30
due_date datetime ➖ The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. 2020-09-30
terms OptionalNullable[str] ➖ Terms of payment. Net 30 days
terms_id OptionalNullable[str] ➖ The ID of the payment terms 12345
po_number OptionalNullable[str] ➖ A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. 90000117
reference OptionalNullable[str] ➖ Optional reference identifier for the transaction. INV-2024-001
status OptionalNullable[models.InvoiceStatus] ➖ Invoice status draft
invoice_sent Optional[bool] ➖ Invoice sent to contact/customer. true
currency OptionalNullable[models.Currency] ➖ Indicates the associated currency for an amount of money. Values correspond to ISO 4217. USD
currency_rate OptionalNullable[float] ➖ Currency Exchange Rate at the time entity was recorded/generated. 0.69
tax_inclusive OptionalNullable[bool] ➖ Amounts are including tax true
sub_total OptionalNullable[float] ➖ Sub-total amount, normally before tax. 27500
total_tax OptionalNullable[float] ➖ Total tax amount applied to this invoice. 2500
tax_code OptionalNullable[str] ➖ Applicable tax id/code override if tax is not supplied on a line item basis. 1234
discount_percentage OptionalNullable[float] ➖ Discount percentage applied to this invoice. 5.5
discount_amount OptionalNullable[float] ➖ Discount amount applied to this invoice. 25
total OptionalNullable[float] ➖ Total amount of invoice, including tax. 27500
balance OptionalNullable[float] ➖ Balance of invoice due. 27500
deposit OptionalNullable[float] ➖ Amount of deposit made to this invoice. 0
customer_memo OptionalNullable[str] ➖ Customer memo Thank you for your business and have a great day!
tracking_category OptionalNullable[models.DeprecatedLinkedTrackingCategory] ➖ : warning: ** DEPRECATED **: This field is deprecated and may be removed in a future version..
tracking_categories List[Nullable[models.LinkedTrackingCategory]] ➖ A list of linked tracking categories.
line_items List[models.InvoiceLineItemInput] ➖ N/A
billing_address Optional[models.Address] ➖ N/A
shipping_address Optional[models.Address] ➖ N/A
template_id OptionalNullable[str] ➖ Optional invoice template 123456
source_document_url OptionalNullable[str] ➖ URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. https://www.invoicesolution.com/invoice/123456
payment_allocations List[models.PaymentAllocations] ➖ IDs of payments made on the invoice
payment_method OptionalNullable[str] ➖ Payment method used for the transaction, such as cash, credit card, bank transfer, or check cash
channel OptionalNullable[str] ➖ The channel through which the transaction is processed. email
language OptionalNullable[str] ➖ language code according to ISO 639-1. For the United States - EN EN
accounting_by_row OptionalNullable[bool] ➖ Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. false
bank_account Optional[models.BankAccount] ➖ N/A
ledger_account OptionalNullable[models.LinkedLedgerAccount] ➖ N/A
custom_fields List[models.CustomField] ➖ N/A
row_version OptionalNullable[str] ➖ A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. 1-12345
pass_through List[models.PassThroughBody] ➖ The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AccountingInvoicesAddResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.UnprocessableResponse 422 application/json
models.APIError 4XX, 5XX */*

get

Get Invoice

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.invoices.get(id="<id>", service_id="salesforce", company_id="12345", raw=False, fields="id,updated_at")

    assert res.get_invoice_response is not None

    # Handle response
    print(res.get_invoice_response)

Parameters

Parameter Type Required Description Example
id str ✔️ ID of the record you are acting upon.
consumer_id Optional[str] ➖ ID of the consumer which you want to get or push data from test-consumer
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
service_id Optional[str] ➖ Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. salesforce
company_id Optional[str] ➖ The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. 12345
raw Optional[bool] ➖ Include raw response. Mostly used for debugging purposes
fields OptionalNullable[str] ➖ The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.		 id,updated_at
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AccountingInvoicesOneResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.UnprocessableResponse 422 application/json
models.APIError 4XX, 5XX */*

update

Update Invoice

Example Usage

import apideck_unify
from apideck_unify import Apideck
from apideck_unify.utils import parse_datetime
from datetime import date
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.invoices.update(id="<id>", service_id="salesforce", raw=False, display_id="123456", type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={
        "id": "12345",
        "display_name": "Windsurf Shop",
        "email": "boring@boring.com",
    }, company_id="12345", location_id="12345", department_id="12345", invoice_date=date.fromisoformat("2020-09-30"), due_date=date.fromisoformat("2020-09-30"), terms="Net 30 days", terms_id="12345", po_number="90000117", reference="123456", status=apideck_unify.InvoiceStatus.DRAFT, invoice_sent=True, currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", discount_percentage=5.5, discount_amount=25, total=27500, balance=27500, deposit=0, customer_memo="Thank you for your business and have a great day!", tracking_categories=[
        {
            "id": "123456",
            "name": "New York",
        },
        {
            "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": apideck_unify.InvoiceLineItemType.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",
        },
        {
            "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": apideck_unify.InvoiceLineItemType.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",
        },
        {
            "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": apideck_unify.InvoiceLineItemType.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": apideck_unify.Type.PRIMARY,
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-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": apideck_unify.Type.PRIMARY,
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-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_": parse_datetime("2020-09-30T07:43:32.000Z"),
        },
        {
            "id": "123456",
            "allocated_amount": 1000,
            "date_": parse_datetime("2020-09-30T07:43:32.000Z"),
        },
        {
            "id": "123456",
            "allocated_amount": 1000,
            "date_": parse_datetime("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": apideck_unify.AccountType.CREDIT_CARD,
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": apideck_unify.Currency.USD,
    }, ledger_account={
        "id": "123456",
        "nominal_code": "N091",
        "code": "453",
    }, custom_fields=[
        {
            "id": "2389328923893298",
            "name": "employee_level",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo",
        },
        {
            "id": "2389328923893298",
            "name": "employee_level",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo",
        },
    ], row_version="1-12345", pass_through=[
        {
            "service_id": "<id>",
            "extend_paths": [
                {
                    "path": "$.nested.property",
                    "value": {
                        "TaxClassificationRef": {
                            "value": "EUC-99990201-V1-00020000",
                        },
                    },
                },
            ],
        },
        {
            "service_id": "<id>",
            "extend_paths": [
                {
                    "path": "$.nested.property",
                    "value": {
                        "TaxClassificationRef": {
                            "value": "EUC-99990201-V1-00020000",
                        },
                    },
                },
            ],
        },
        {
            "service_id": "<id>",
            "extend_paths": [
                {
                    "path": "$.nested.property",
                    "value": {
                        "TaxClassificationRef": {
                            "value": "EUC-99990201-V1-00020000",
                        },
                    },
                },
            ],
        },
    ])

    assert res.update_invoice_response is not None

    # Handle response
    print(res.update_invoice_response)

Parameters

Parameter Type Required Description Example
id str ✔️ ID of the record you are acting upon.
consumer_id Optional[str] ➖ ID of the consumer which you want to get or push data from test-consumer
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
service_id Optional[str] ➖ Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. salesforce
raw Optional[bool] ➖ Include raw response. Mostly used for debugging purposes
display_id OptionalNullable[str] ➖ Id to be displayed. 123456
type OptionalNullable[models.InvoiceType] ➖ Invoice type service
number OptionalNullable[str] ➖ Invoice number. OIT00546
customer OptionalNullable[models.LinkedCustomerInput] ➖ The customer this entity is linked to.
company_id OptionalNullable[str] ➖ The company ID the transaction belongs to 12345
location_id OptionalNullable[str] ➖ The ID of the location 12345
department_id OptionalNullable[str] ➖ The ID of the department 12345
invoice_date datetime ➖ Date invoice was issued - YYYY-MM-DD. 2020-09-30
due_date datetime ➖ The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. 2020-09-30
terms OptionalNullable[str] ➖ Terms of payment. Net 30 days
terms_id OptionalNullable[str] ➖ The ID of the payment terms 12345
po_number OptionalNullable[str] ➖ A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. 90000117
reference OptionalNullable[str] ➖ Optional reference identifier for the transaction. INV-2024-001
status OptionalNullable[models.InvoiceStatus] ➖ Invoice status draft
invoice_sent Optional[bool] ➖ Invoice sent to contact/customer. true
currency OptionalNullable[models.Currency] ➖ Indicates the associated currency for an amount of money. Values correspond to ISO 4217. USD
currency_rate OptionalNullable[float] ➖ Currency Exchange Rate at the time entity was recorded/generated. 0.69
tax_inclusive OptionalNullable[bool] ➖ Amounts are including tax true
sub_total OptionalNullable[float] ➖ Sub-total amount, normally before tax. 27500
total_tax OptionalNullable[float] ➖ Total tax amount applied to this invoice. 2500
tax_code OptionalNullable[str] ➖ Applicable tax id/code override if tax is not supplied on a line item basis. 1234
discount_percentage OptionalNullable[float] ➖ Discount percentage applied to this invoice. 5.5
discount_amount OptionalNullable[float] ➖ Discount amount applied to this invoice. 25
total OptionalNullable[float] ➖ Total amount of invoice, including tax. 27500
balance OptionalNullable[float] ➖ Balance of invoice due. 27500
deposit OptionalNullable[float] ➖ Amount of deposit made to this invoice. 0
customer_memo OptionalNullable[str] ➖ Customer memo Thank you for your business and have a great day!
tracking_category OptionalNullable[models.DeprecatedLinkedTrackingCategory] ➖ : warning: ** DEPRECATED **: This field is deprecated and may be removed in a future version..
tracking_categories List[Nullable[models.LinkedTrackingCategory]] ➖ A list of linked tracking categories.
line_items List[models.InvoiceLineItemInput] ➖ N/A
billing_address Optional[models.Address] ➖ N/A
shipping_address Optional[models.Address] ➖ N/A
template_id OptionalNullable[str] ➖ Optional invoice template 123456
source_document_url OptionalNullable[str] ➖ URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. https://www.invoicesolution.com/invoice/123456
payment_allocations List[models.PaymentAllocations] ➖ IDs of payments made on the invoice
payment_method OptionalNullable[str] ➖ Payment method used for the transaction, such as cash, credit card, bank transfer, or check cash
channel OptionalNullable[str] ➖ The channel through which the transaction is processed. email
language OptionalNullable[str] ➖ language code according to ISO 639-1. For the United States - EN EN
accounting_by_row OptionalNullable[bool] ➖ Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. false
bank_account Optional[models.BankAccount] ➖ N/A
ledger_account OptionalNullable[models.LinkedLedgerAccount] ➖ N/A
custom_fields List[models.CustomField] ➖ N/A
row_version OptionalNullable[str] ➖ A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. 1-12345
pass_through List[models.PassThroughBody] ➖ The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AccountingInvoicesUpdateResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.UnprocessableResponse 422 application/json
models.APIError 4XX, 5XX */*

delete

Delete Invoice

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.invoices.delete(id="<id>", service_id="salesforce", raw=False)

    assert res.delete_invoice_response is not None

    # Handle response
    print(res.delete_invoice_response)

Parameters

Parameter Type Required Description Example
id str ✔️ ID of the record you are acting upon.
consumer_id Optional[str] ➖ ID of the consumer which you want to get or push data from test-consumer
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
service_id Optional[str] ➖ Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. salesforce
raw Optional[bool] ➖ Include raw response. Mostly used for debugging purposes
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AccountingInvoicesDeleteResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.UnprocessableResponse 422 application/json
models.APIError 4XX, 5XX */*