Create Invoice
POST {{baseUrl}}/accounting/invoices?raw=false
Create Invoice
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
raw | boolean | Include raw response. Mostly used for debugging purposes |
Request Body
{"type"=>"service", "number"=>"OIT00546", "customer"=>{"id"=>"{{primaryCustomerId}}", "display_name"=>"Windsurf Shop", "name"=>"Windsurf Shop", "email"=>"boring@boring.com"}, "company_id"=>"12345", "invoice_date"=>"2020-09-30", "due_date"=>"2020-09-30", "terms"=>"Net 30 days", "po_number"=>"90000117", "reference"=>"123456", "status"=>"draft", "invoice_sent"=>true, "currency"=>"USD", "currency_rate"=>0.69, "tax_inclusive"=>true, "sub_total"=>27500, "total_tax"=>2500, "tax_code"=>"1234", "discount_percentage"=>5.5, "discount_amount"=>25, "total"=>27500, "balance"=>27500, "deposit"=>0, "customer_memo"=>"Thank you for your business and have a great day!", "tracking_category"=>{"id"=>"123456", "name"=>"New York"}, "tracking_categories"=>[{"id"=>"123456", "name"=>"New York"}, {"id"=>"123456", "name"=>"New York"}], "line_items"=>[{"row_id"=>"{{invoiceLineItemRowId}}", "code"=>"{{primaryInvoiceItemCode}}", "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, "unit_of_measure"=>"each", "discount_percentage"=>0, "tax_rate"=>{"code"=>"{{primaryTaxType}}"}, "ledger_account"=>{"code"=>"{{accountsReceivableAccountCode}}"}, "row_version"=>"{{invoiceLineItemRowVersion}}"}], "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"}, "source_document_url"=>"https://www.invoicesolution.com/invoice/123456", "payment_method"=>"cash", "channel"=>"email", "language"=>"EN", "accounting_by_row"=>false, "bank_account"=>{"bank_name"=>"Monzo", "account_number"=>"123465", "account_name"=>"SPACEX LLC", "account_type"=>"credit_card", "iban"=>"CH2989144532982975332", "bic"=>"AUDSCHGGXXX", "routing_number"=>"012345678", "bsb_number"=>"062-001", "branch_identifier"=>"001", "bank_code"=>"BNH", "currency"=>"USD"}, "ledger_account"=>{"id"=>"123456", "nominal_code"=>"N091", "code"=>"453"}, "custom_fields"=>[{"id"=>"2389328923893298", "name"=>"employee_level", "description"=>"Employee Level", "value"=>"Uses Salesforce and Marketo"}, {"id"=>"2389328923893298", "name"=>"employee_level", "description"=>"Employee Level", "value"=>"Uses Salesforce and Marketo"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-apideck-consumer-id | string | (Required) ID of the consumer which you want to get or push data from | |
x-apideck-app-id | string | (Required) The ID of your Unify application | |
x-apideck-service-id | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"status_code":200,"status":"OK","service":"xero","resource":"invoices","operation":"add","data":{"id":"12345","downstream_id":"12345"}}