Skip to main content

POST /sales/invoices

POST 

/sales/invoices

POST /sales/invoices

Request​

Body

    id int64nullable
    uid uuidnullable
    created_at date-timenullable
    edited_at date-timenullable
    is_locked boolean
    total_amount doublenullable
    subtotal_amount doublenullable
    amount_paid doublenullable

    bank_account

    object

    id int32nullable
    account_number stringnullable

    billing_address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    counter_id int32nullable
    currency stringnullable

    Possible values: <= 3 characters

    customer

    object

    id int64nullable
    business_name stringnullable
    display_name stringnullable
    reg_no stringnullable
    vat_no stringnullable
    tax_no stringnullable

    address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    email stringnullable
    preferred_locale stringnullable
    phone stringnullable
    culture stringnullable
    date_issued datenullable
    date_taxable datenullable
    date_due datenullable

    delivery_condition

    object

    id int32nullable
    code stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable
    no stringnullable
    notes stringnullable
    memo stringnullable

    org

    object

    name stringnullable
    reg_no stringnullable
    tax_no stringnullable
    vat_no stringnullable
    eori_no stringnullable

    address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    info_legal stringnullable

    config

    object

    logo stringnullable
    signature stringnullable
    website stringnullable
    email stringnullable
    phone stringnullable
    fb stringnullable
    insta stringnullable
    payment_reference stringnullable
    payment_info stringnullable

    payment_term

    object

    id int32nullable
    code stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable
    precision int32

    Default value: 2

    rate_format stringnullable
    taxes_included boolean
    tax_fx_rate doublenullable

    shipping_address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    tax_nexus

    object

    id int32nullable
    code stringnullable
    currency stringnullable

    taxes

    object[]

    nullable

  • Array [

  • index int64nullable
    code stringnullable
    name stringnullable
    currency stringnullable
    rate_type stringnullable
    is_implicit boolean

    rates

    object[]

    nullable

  • Array [

  • rate double
    is_default boolean
  • ]

  • ]

  • jurisdiction

    object

    country stringnullable
    region stringnullable
    subregion stringnullable
    city stringnullable
    postal_code stringnullable
    registration_mode stringnullable
    template_layout stringnullable
    document_locale stringnullable

    type

    object

    id int32nullable
    name stringnullable
    associated_payment_cards string[]nullable
    payment_status stringnullable
    overdue_days int32nullable
    shopify_object_id int64nullable
    stripe_object_id stringnullable
    woocommerce_order_id int64nullable
    eshop_order_id int64nullable

    purchase_order

    object

    id int64nullable
    no stringnullable
    ext_id stringnullable
    url stringnullable
    payment_status stringnullable
    fulfillment_status stringnullable

    sales_order

    object

    id int64nullable
    no stringnullable
    ext_id stringnullable
    url stringnullable
    payment_status stringnullable
    fulfillment_status stringnullable

    items

    object[]

    nullable

  • Array [

  • id int64nullable
    title stringnullable
    description stringnullable
    qty double
    rate doublenullable
    rate_netto doublenullable
    rate_gross doublenullable
    rate_discounted doublenullable
    rate_discounted_netto doublenullable
    rate_discounted_gross doublenullable
    discount_explicit double
    discount_implicit double
    amount doublenullable
    amount_netto doublenullable
    amount_gross doublenullable
    tax_amount doublenullable
    shopify_line_id int64nullable
    stripe_object_id stringnullable
    woocommerce_line_id int64nullable
    eshop_line_id int64nullable
    sku stringnullable
    barcode stringnullable
    country_of_origin stringnullable
    harmonized_system_code stringnullable
    weight_grams doublenullable
    requires_shipping boolean

    item

    object

    id int64
    sku stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable
    desc_org stringnullable
    desc_leg stringnullable
    desc stringnullable

    variant

    object

    id int64
    name stringnullable

    unit

    object

    id int32nullable
    code stringnullable
    unece_code stringnullable
    symbol_org stringnullable
    symbol_leg stringnullable
    symbol stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable

    taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • ]

  • taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • shipping_charges

    object[]

    nullable

  • Array [

  • id int64nullable
    title stringnullable
    amount doublenullable
    discount_implicit doublenullable
    shopify_line_id int64nullable
    stripe_object_id stringnullable
    woocommerce_line_id int64nullable
    eshop_line_id int64nullable

    taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • ]

  • duties

    object[]

    nullable

  • Array [

  • id int64nullable
    title stringnullable
    amount doublenullable
    discount_implicit doublenullable
    shopify_line_id int64nullable
    stripe_object_id stringnullable
    woocommerce_line_id int64nullable
    eshop_line_id int64nullable

    taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • ]

  • discounts

    object[]

    nullable

  • Array [

  • title stringnullable
    amount double
    value doublenullable
    value_type stringnullable
    allocation_method stringnullable
    target_type stringnullable
  • ]

  • status Apollo.API.Models.Sales.Status (string)

    Possible values: [DRAFT, PROCESSED, VOIDED]

    fx_rates

    object[]

    nullable

  • Array [

  • rate double
    currency_code stringnullable
    source stringnullable
  • ]

  • urls

    object[]

    nullable

  • Array [

  • token stringnullable
    expire_at date-timenullable
    url stringnullable
  • ]

  • metadata

    object

    nullable

    compliance

    object

    status Apollo.Models.Compliance.ComplianceStatus (string)

    Possible values: [pending, evaluated, blocked]

    reporting_method Apollo.Models.Compliance.ReportingMethod (string)

    Possible values: [no_reporting, reporting_by_delivery]

    delivery_eligibility Apollo.Models.Compliance.DeliveryEligibility (string)

    Possible values: [eligible, eligible_via_required_channel]

    required_action Apollo.Models.Compliance.RequiredAction (string)

    Possible values: [none, send_via_peppol]

    allowed_actions

    object

    send_email boolean
    download_pdf boolean
    send_via_peppol boolean
    submit_to_tax_authority boolean
    evaluated_at date-timenullable
    blocking_reason stringnullable

Responses​

OK

Schema

    id int64nullable
    uid uuidnullable
    created_at date-timenullable
    edited_at date-timenullable
    is_locked boolean
    total_amount doublenullable
    subtotal_amount doublenullable
    amount_paid doublenullable
    amount_due doublenullable
    total_items_amount doublenullable
    total_taxes_amount doublenullable
    total_taxes_rate doublenullable

    bank_account

    object

    id int32nullable
    account_number stringnullable

    billing_address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    counter_id int32nullable
    currency stringnullable

    Possible values: <= 3 characters

    customer

    object

    id int64nullable
    business_name stringnullable
    display_name stringnullable
    reg_no stringnullable
    vat_no stringnullable
    tax_no stringnullable

    address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    email stringnullable
    preferred_locale stringnullable
    phone stringnullable
    culture stringnullable
    date_issued datenullable
    date_taxable datenullable
    date_due datenullable

    delivery_condition

    object

    id int32nullable
    code stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable
    no stringnullable
    notes stringnullable
    memo stringnullable

    org

    object

    name stringnullable
    reg_no stringnullable
    tax_no stringnullable
    vat_no stringnullable
    eori_no stringnullable

    address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    info_legal stringnullable

    config

    object

    logo stringnullable
    signature stringnullable
    website stringnullable
    email stringnullable
    phone stringnullable
    fb stringnullable
    insta stringnullable
    payment_reference stringnullable
    payment_info stringnullable

    payment_term

    object

    id int32nullable
    code stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable
    precision int32

    Default value: 2

    rate_format stringnullable
    taxes_included boolean
    tax_fx_rate doublenullable

    shipping_address

    object

    name stringnullable
    company stringnullable
    address1 stringnullable
    address2 stringnullable
    postal_code stringnullable
    city stringnullable
    region stringnullable
    country stringnullable

    Possible values: <= 2 characters

    tax_nexus

    object

    id int32nullable
    code stringnullable
    currency stringnullable

    taxes

    object[]

    nullable

  • Array [

  • index int64nullable
    code stringnullable
    name stringnullable
    currency stringnullable
    rate_type stringnullable
    is_implicit boolean

    rates

    object[]

    nullable

  • Array [

  • rate double
    is_default boolean
  • ]

  • ]

  • jurisdiction

    object

    country stringnullable
    region stringnullable
    subregion stringnullable
    city stringnullable
    postal_code stringnullable
    registration_mode stringnullable
    template_layout stringnullable
    document_locale stringnullable

    type

    object

    id int32nullable
    name stringnullable
    associated_payment_cards string[]nullable
    payment_status stringnullable
    overdue_days int32nullable
    shopify_object_id int64nullable
    stripe_object_id stringnullable
    woocommerce_order_id int64nullable
    eshop_order_id int64nullable

    purchase_order

    object

    id int64nullable
    no stringnullable
    ext_id stringnullable
    url stringnullable
    payment_status stringnullable
    fulfillment_status stringnullable

    sales_order

    object

    id int64nullable
    no stringnullable
    ext_id stringnullable
    url stringnullable
    payment_status stringnullable
    fulfillment_status stringnullable

    items

    object[]

    nullable

  • Array [

  • id int64nullable
    title stringnullable
    description stringnullable
    qty double
    rate doublenullable
    rate_netto doublenullable
    rate_gross doublenullable
    rate_discounted doublenullable
    rate_discounted_netto doublenullable
    rate_discounted_gross doublenullable
    discount_explicit double
    discount_implicit double
    amount doublenullable
    amount_netto doublenullable
    amount_gross doublenullable
    tax_amount doublenullable
    total_taxes_amount doublenullable
    total_taxes_rate doublenullable
    shopify_line_id int64nullable
    stripe_object_id stringnullable
    woocommerce_line_id int64nullable
    eshop_line_id int64nullable
    sku stringnullable
    barcode stringnullable
    country_of_origin stringnullable
    harmonized_system_code stringnullable
    weight_grams doublenullable
    requires_shipping boolean

    item

    object

    id int64
    sku stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable
    desc_org stringnullable
    desc_leg stringnullable
    desc stringnullable

    variant

    object

    id int64
    name stringnullable

    unit

    object

    id int32nullable
    code stringnullable
    unece_code stringnullable
    symbol_org stringnullable
    symbol_leg stringnullable
    symbol stringnullable
    name_org stringnullable
    name_leg stringnullable
    name stringnullable

    taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • ]

  • taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    total_amount doublenullable
    total_amount_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • shipping_charges

    object[]

    nullable

  • Array [

  • id int64nullable
    title stringnullable
    amount doublenullable
    discount_implicit doublenullable
    shopify_line_id int64nullable
    stripe_object_id stringnullable
    woocommerce_line_id int64nullable
    eshop_line_id int64nullable

    taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • ]

  • duties

    object[]

    nullable

  • Array [

  • id int64nullable
    title stringnullable
    amount doublenullable
    discount_implicit doublenullable
    shopify_line_id int64nullable
    stripe_object_id stringnullable
    woocommerce_line_id int64nullable
    eshop_line_id int64nullable

    taxes

    object[]

    nullable

  • Array [

  • id int64nullable
    tax_rate doublenullable
    tax_amount doublenullable
    tax_amount_leg doublenullable
    tax_base doublenullable
    tax_base_leg doublenullable
    currency_leg stringnullable
    tax_index int32nullable
    tax_code stringnullable
    tax_name stringnullable
    rate_type stringnullable

    tax_details

    object

    nullable

  • ]

  • ]

  • discounts

    object[]

    nullable

  • Array [

  • title stringnullable
    amount double
    value doublenullable
    value_type stringnullable
    allocation_method stringnullable
    target_type stringnullable
  • ]

  • status Apollo.API.Models.Sales.Status (string)

    Possible values: [DRAFT, PROCESSED, VOIDED]

    fx_rates

    object[]

    nullable

  • Array [

  • rate double
    currency_code stringnullable
    source stringnullable
  • ]

  • urls

    object[]

    nullable

  • Array [

  • token stringnullable
    expire_at date-timenullable
    url stringnullable
  • ]

  • url stringnullable

    metadata

    object

    nullable

    compliance

    object

    status Apollo.Models.Compliance.ComplianceStatus (string)

    Possible values: [pending, evaluated, blocked]

    reporting_method Apollo.Models.Compliance.ReportingMethod (string)

    Possible values: [no_reporting, reporting_by_delivery]

    delivery_eligibility Apollo.Models.Compliance.DeliveryEligibility (string)

    Possible values: [eligible, eligible_via_required_channel]

    required_action Apollo.Models.Compliance.RequiredAction (string)

    Possible values: [none, send_via_peppol]

    allowed_actions

    object

    send_email boolean
    download_pdf boolean
    send_via_peppol boolean
    submit_to_tax_authority boolean
    evaluated_at date-timenullable
    blocking_reason stringnullable
Loading...