INinvoiceninja
credits

Upload a credit document

Changed on

Handles the uploading of a document to a credit

post/api/v1/credits/{id}/upload

Request

Path parameters

idstring string required

The Credit Hashed ID

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Request body multipart/form-data

_methodstring
documentsstring[]

Example request

{
  "_method": "PUT"
}

Response

Returns the Credit object

idstring

The unique hashed ID of the credit

user_idstring

The unique hashed ID of the user associated with the credit

assigned_user_idstring

The unique hashed ID of the assigned user responsible for the credit

client_idstring

The unique hashed ID of the client associated with the credit

status_idstring

The ID representing the current status of the credit

invoice_idstring

The unique hashed ID of the linked invoice to which the credit is applied

numberstring

The unique alphanumeric credit number per company

po_numberstring

The purchase order number referred to by the credit

termsstring

The terms associated with the credit

public_notesstring

Public notes for the credit

private_notesstring

Private notes for internal use, not visible to the client

footerstring

The footer text for the credit

custom_value1string

Custom value 1 for additional credit information

custom_value2string

Custom value 2 for additional credit information

custom_value3string

Custom value 3 for additional credit information

custom_value4string

Custom value 4 for additional credit information

tax_name1string

The name of the first tax applied to the credit

tax_name2string

The name of the second tax applied to the credit

tax_rate1number float

The rate of the first tax applied to the credit

tax_rate2number float

The rate of the second tax applied to the credit

tax_name3string

The name of the third tax applied to the credit

tax_rate3number float

The rate of the third tax applied to the credit

total_taxesnumber float

The total amount of taxes for the credit

amountnumber float

The total amount of the credit

balancenumber float

The outstanding balance of the credit

paid_to_datenumber float

The total amount paid to date for the credit

discountnumber float

The discount applied to the credit

partialnumber float

The partial amount applied to the credit

is_amount_discountboolean

Indicates whether the discount applied is a fixed amount or a percentage

is_deletedboolean

Indicates whether the credit has been deleted

uses_inclusive_taxesboolean

Indicates whether the tax rates applied to the credit are inclusive or exclusive

datestring date

The date the credit was issued

last_sent_datestring date

The date the credit was last sent out

next_send_datestring date

The next scheduled date for sending a credit reminder

partial_due_datestring date

The due date for the partial amount of the credit

due_datestring date

The due date for the total amount of the credit

last_viewednumber

The timestamp of the last time the credit was viewed

updated_atnumber

The timestamp of the last time the credit was updated

archived_atnumber

The timestamp of the last time the credit was archived

custom_surcharge1number float

First custom surcharge amount

custom_surcharge2number float

Second Custom Surcharge

custom_surcharge3number float

Third Custom Surcharge

custom_surcharge4number float

Fourth Custom Surcharge

custom_surcharge_tax1boolean

Toggles charging taxes on custom surcharge amounts

custom_surcharge_tax2boolean

Toggles charging taxes on custom surcharge amounts

custom_surcharge_tax3boolean

Toggles charging taxes on custom surcharge amounts

custom_surcharge_tax4boolean

Toggles charging taxes on custom surcharge amounts

location_idstring

The client location id that this invoice relates to

design_idstring

The unique identifier of the design template used for this credit

exchange_ratenumber float

The exchange rate used for currency conversion

project_idstring

The unique identifier of the project associated with this credit

subscription_idstring

The unique identifier of the subscription associated with this credit

vendor_idstring

The unique identifier of the vendor associated with this credit

Example response

{
  "id": "Opnel5aKBz",
  "user_id": "1a2b3c4d5e",
  "assigned_user_id": "6f7g8h9i0j",
  "client_id": "p1q2r3s4t5",
  "status_id": "3",
  "invoice_id": "u1v2w3x4y5",
  "number": "QUOTE_101",
  "po_number": "PO_12345",
  "terms": "Net 30",
  "public_notes": "Thank you for your business.",
  "private_notes": "Client is requesting a discount.",
  "footer": "Footer text goes here.",
  "custom_value1": "Custom data 1",
  "custom_value2": "Custom data 2",
  "custom_value3": "Custom data 3",
  "custom_value4": "Custom data 4",
  "tax_name1": "VAT",
  "tax_name2": "GST",
  "tax_rate1": 10,
  "tax_rate2": 5,
  "tax_name3": "PST",
  "tax_rate3": 8,
  "total_taxes": 23,
  "line_items": [
    {
      "quantity": 1,
      "cost": 10,
      "product_key": "Product key",
      "tags": "Retail,Priority Customer",
      "product_cost": 10,
      "notes": "Item notes",
      "discount": 5,
      "tax_name1": "GST",
      "tax_rate1": 10,
      "tax_name2": "VAT",
      "tax_rate2": 5,
      "tax_name3": "CA Sales Tax",
      "tax_rate3": 3,
      "sort_id": "0",
      "line_total": 10,
      "gross_line_total": 15,
      "tax_amount": 1,
      "custom_value1": "Custom value 1",
      "custom_value2": "Custom value 2",
      "custom_value3": "Custom value 3",
      "custom_value4": "Custom value 4",
      "type_id": "1",
      "tax_id": "1"
    }
  ],
  "invitations": [
    {
      "id": "Opnel5aKBz",
      "client_contact_id": "Opnel5aKBz",
      "key": "Opnel5aKBz4343343566236gvbb",
      "link": "https://www.example.com/invitations/Opnel5aKBz4343343566236gvbb",
      "updated_at": 1434342123,
      "archived_at": 1434342123,
      "email_error": "The email error"
    }
  ],
  "amount": 100,
  "balance": 50,
  "paid_to_date": 50,
  "discount": 10,
  "partial": 20,
  "is_amount_discount": true,
  "uses_inclusive_taxes": true,
  "date": "1994-07-30",
  "last_sent_date": "1994-07-30",
  "next_send_date": "1994-07-30",
  "partial_due_date": "1994-07-30",
  "due_date": "1994-07-30",
  "settings": {
    "currency_id": "1",
    "timezone_id": "15",
    "date_format_id": "15",
    "military_time": true,
    "language_id": "1",
    "show_currency_code": true,
    "payment_terms": 1,
    "company_gateway_ids": "1,2,3,4",
    "custom_value1": "Custom Label",
    "custom_value2": "Custom Label",
    "custom_value3": "Custom Label",
    "custom_value4": "Custom Label",
    "default_task_rate": 10,
    "send_reminders": true,
    "enable_client_portal_tasks": true,
    "email_style": "light",
    "reply_to_email": "email@gmail.com",
    "bcc_email": "email@gmail.com, contact@gmail.com",
    "pdf_email_attachment": true,
    "ubl_email_attachment": true,
    "email_style_custom": "<HTML></HTML>",
    "counter_number_applied": "when_sent",
    "quote_number_applied": "when_sent",
    "custom_message_dashboard": "Please pay invoices immediately",
    "custom_message_unpaid_invoice": "Please pay invoices immediately",
    "custom_message_paid_invoice": "Thanks for paying this invoice!",
    "custom_message_unapproved_quote": "Please approve quote",
    "lock_invoices": "off",
    "auto_archive_invoice": true,
    "auto_archive_quote": true,
    "auto_convert_quote": true,
    "inclusive_taxes": true,
    "translations": {},
    "task_number_pattern": "{$year}-{$counter}",
    "task_number_counter": 1,
    "reminder_send_time": 32400,
    "expense_number_pattern": "{$year}-{$counter}",
    "expense_number_counter": 1,
    "vendor_number_pattern": "{$year}-{$counter}",
    "vendor_number_counter": 1,
    "ticket_number_pattern": "{$year}-{$counter}",
    "ticket_number_counter": 1,
    "payment_number_pattern": "{$year}-{$counter}",
    "payment_number_counter": 1,
    "invoice_number_pattern": "{$year}-{$counter}",
    "invoice_number_counter": 1,
    "quote_number_pattern": "{$year}-{$counter}",
    "quote_number_counter": 1,
    "client_number_pattern": "{$year}-{$counter}",
    "client_number_counter": 1,
    "credit_number_pattern": "{$year}-{$counter}",
    "credit_number_counter": 1,
    "recurring_invoice_number_prefix": "R",
    "reset_counter_frequency_id": 1,
    "reset_counter_date": "2019-01-01",
    "counter_padding": 1,
    "shared_invoice_quote_counter": true,
    "update_products": true,
    "convert_products": true,
    "fill_products": true,
    "invoice_terms": "Invoice Terms are...",
    "quote_terms": "Quote Terms are...",
    "invoice_taxes": 1,
    "invoice_design_id": "1",
    "quote_design_id": "1",
    "invoice_footer": "1",
    "invoice_labels": "1",
    "tax_rate1": 10,
    "tax_name1": "GST",
    "tax_rate2": 10,
    "tax_name2": "GST",
    "tax_rate3": 10,
    "tax_name3": "GST",
    "payment_type_id": "1",
    "custom_fields": "{}",
    "email_footer": "A default email footer",
    "email_sending_method": "default",
    "gmail_sending_user_id": "F76sd34D",
    "email_subject_invoice": "Your Invoice Subject",
    "email_subject_quote": "Your Quote Subject",
    "email_subject_payment": "Your Payment Subject",
    "email_template_invoice": "<HTML></HTML>",
    "email_template_quote": "<HTML></HTML>",
    "email_template_payment": "<HTML></HTML>",
    "email_subject_reminder1": "<HTML></HTML>",
    "email_subject_reminder2": "<HTML></HTML>",
    "email_subject_reminder3": "<HTML></HTML>",
    "email_subject_reminder_endless": "<HTML></HTML>",
    "email_template_reminder1": "<HTML></HTML>",
    "email_template_reminder2": "<HTML></HTML>",
    "email_template_reminder3": "<HTML></HTML>",
    "email_template_reminder_endless": "<HTML></HTML>",
    "enable_portal_password": true,
    "show_accept_invoice_terms": true,
    "show_accept_quote_terms": true,
    "require_invoice_signature": true,
    "require_quote_signature": true,
    "name": "Acme Co",
    "company_logo": "logo.png",
    "website": "https://www.acme.com",
    "address1": "Suite 888",
    "address2": "5 Jimbo Way",
    "city": "Sydney",
    "state": "Florida",
    "postal_code": "90210",
    "phone": "555-213-3948",
    "email": "joe@acme.co",
    "country_id": "1",
    "vat_number": "32 120 377 720",
    "page_size": "A4",
    "font_size": 9,
    "primary_font": "roboto",
    "secondary_font": "roboto",
    "email_template_statement": "template matter",
    "email_subject_statement": "subject matter",
    "quote_footer": "the quote footer",
    "email_subject_custom1": "Custom Subject 1",
    "email_subject_custom2": "Custom Subject 2",
    "email_subject_custom3": "Custom Subject 3",
    "email_template_custom1": "<HTML></HTML>",
    "email_template_custom2": "<HTML></HTML>",
    "email_template_custom3": "<HTML></HTML>",
    "num_days_reminder1": 9,
    "num_days_reminder2": 9,
    "num_days_reminder3": 9,
    "schedule_reminder1": "after_invoice_date",
    "schedule_reminder2": "after_invoice_date",
    "schedule_reminder3": "after_invoice_date",
    "late_fee_amount1": 10,
    "late_fee_amount2": 20,
    "late_fee_amount3": 100,
    "endless_reminder_frequency_id": "1",
    "default_expense_payment_type_id": "0",
    "e_invoice_type": "EN16931",
    "mailgun_endpoint": "api.mailgun.net",
    "client_initiated_payments_minimum": 10,
    "custom_sending_email": "bob@gmail.com",
    "company_logo_size": 100,
    "email_alignment": "left",
    "postmark_secret": "123456",
    "mailgun_secret": "123456",
    "mailgun_domain": "sandbox123456.mailgun.org",
    "besr_id": "123456",
    "qr_iban": "CH123456",
    "email_subject_purchase_order": "Purchase Order",
    "email_template_purchase_order": "Please see attached your purchase order.",
    "purchase_order_public_notes": "Please see attached your purchase order.",
    "purchase_order_terms": "Please see attached your purchase order.",
    "purchase_order_footer": "Please see attached your purchase order.",
    "purchase_order_design_id": "hd677df",
    "purchase_order_number_pattern": "PO-000000",
    "purchase_order_number_counter": 1,
    "page_numbering_alignment": "left",
    "email_from_name": "Bob Smith",
    "show_all_tasks_client_portal": "all",
    "entity_send_time": 9,
    "reply_to_name": "Bob Smith",
    "recurring_invoice_number_pattern": "R-000000",
    "recurring_invoice_number_counter": 1,
    "client_portal_under_payment_minimum": 10,
    "auto_bill_date": "on_send_date",
    "primary_color": "#ffffff",
    "secondary_color": "#ffffff",
    "auto_bill": "off",
    "client_portal_terms": "Please see attached your invoice.",
    "client_portal_privacy_policy": "These are the terms of use for using the client portal.",
    "portal_design_id": "hd677df",
    "late_fee_endless_percent": 10,
    "late_fee_endless_amount": 10,
    "email_signature": "Bob Smith",
    "classification": "individual",
    "valid_until": "30 days",
    "credit_terms": "Credit note terms",
    "credit_footer": "Credit note footer"
  },
  "last_viewed": 1434342123,
  "updated_at": 1434342123,
  "archived_at": 1434342123,
  "custom_surcharge1": 10,
  "custom_surcharge2": 10,
  "custom_surcharge3": 10,
  "custom_surcharge4": 10,
  "custom_surcharge_tax1": true,
  "custom_surcharge_tax2": true,
  "custom_surcharge_tax3": true,
  "custom_surcharge_tax4": true,
  "location_id": "Opnel5aKBz",
  "design_id": "Opnel5aKBz",
  "exchange_rate": 1,
  "project_id": "Opnel5aKBz",
  "subscription_id": "Opnel5aKBz",
  "vendor_id": "Opnel5aKBz"
}

Changes

  • a8b7a375e4edRevision changes
    • info

      added the optional property // to the response with the status

  • 69a36036d334Revision changes
    • info

      added the optional property // to the response with the status

    • info

      the response optional property became read-only for the status