v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Invoice

Gets an Invoice by Id

Return an Invoice based on Invoice Id.

get/financials/invoices/{invoice_id}

Path parameters

invoice_idinteger required

The invoice header identifier

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

Invoice with a header and all details

idinteger

Invoice Identifier

invoice_numberstring

Invoice Number

is_auto_billboolean

If Auto Bill is set to true

client_idinteger

Client Identifier for the client associated with the invoice

lead_idinteger

Lead Identifier of the lead associated with the invoice

dropin_idinteger

DropInIdentifier

payment_duestring date

Payment Due Date

paid_onstring date-time

Paid On Date Time

paid_on_datestring date

Paid On Date

location_idinteger

Location Identifier

locationstring

Location

reservation_idinteger

Class Reservation Identifier

discount_amountnumber

Discount Amount

discount_percentagenumber

Discount Percent

payment_method_idinteger

Payment Method Identifier

payment_method_expiration_datestring date

Payment Method Expiration Date

invoice_header_status_idinteger

Invoice Header Status Identifier

invoice_header_statusstring

Invoice Header Status

gross_line_discountsnumber

Gross Line Discounts

net_line_discountsnumber

Net Line Discounts

gross_header_discountsnumber

Gross Header Discounts

gross_total_discountsnumber

Gross Total Discounts

net_total_discountsnumber

Net Total Discounts

gross_revenue_adjustmentnumber

Gross Revenue Adjustment

refunded_revenuenumber

Refunded Revenue

gross_revenuenumber

Gross Revenue

post_header_gross_revenuenumber

Post Header Gross Revenue

net_revenuenumber

Net Revenue

post_header_net_revenuenumber

Post Header Net Revenue

gross_taxnumber

Gross Tax

refunded_taxnumber

Refunded Tax

final_refunded_amountnumber

Final Refunded Amount

final_taxnumber

Final Tax

final_chargenumber

Final Charge

refundable_final_chargenumber

Refundable Final Charge

paid_amountnumber

Paid Amount

unpaid_amountnumber

Unpaid Amount

notesstring

Notes

invoice_footerstring

Invoice Footer

last_status_change_byinteger

Last Status Change by (User Identifier)

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

an UserException with Abort Transaction = Yes, and a Log Error = No
an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

Example response

{
  "client_id": 1234567891234567,
  "lead_id": 1234567891234567,
  "dropin_id": 1234567891234567,
  "payment_due": "2014-12-31",
  "paid_on": "2014-12-31T23:59:59.938Z",
  "paid_on_date": "2014-12-31",
  "reservation_id": 1234567891234567,
  "discount_amount": 0.1,
  "discount_percentage": 0.1,
  "payment_method_id": 1234567891234567,
  "payment_method_expiration_date": "2014-12-31",
  "gross_line_discounts": 0.1,
  "net_line_discounts": 0.1,
  "gross_header_discounts": 0.1,
  "gross_total_discounts": 0.1,
  "net_total_discounts": 0.1,
  "gross_revenue_adjustment": 0.1,
  "refunded_revenue": 0.1,
  "gross_revenue": 0.1,
  "post_header_gross_revenue": 0.1,
  "net_revenue": 0.1,
  "post_header_net_revenue": 0.1,
  "gross_tax": 0.1,
  "refunded_tax": 0.1,
  "final_refunded_amount": 0.1,
  "final_tax": 0.1,
  "final_charge": 0.1,
  "refundable_final_charge": 0.1,
  "paid_amount": 0.1,
  "unpaid_amount": 0.1,
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "last_status_change_by": 1234567891234567,
  "invoice_details": [
    {
      "product_variant_id": 1234567891234567,
      "product_type_id": 1234567891234567,
      "revenue_category_id": 1234567891234567,
      "cost_per_unit": 0.1,
      "list_price": 0.1,
      "sales_price": 0.1,
      "price_adjustment": 0.1,
      "expected_revenue": 0.1,
      "gross_line_discount": 0.1,
      "net_line_discount": 0.1,
      "discount_amount": 0.1,
      "discount_percentage": 0.1,
      "gross_header_discount": 0.1,
      "net_header_discount": 0.1,
      "header_discount_amount": 0.1,
      "header_discount_percentage": 0.1,
      "gross_total_discount": 0.1,
      "net_total_discount": 0.1,
      "gross_revenue_adjustment": 0.1,
      "net_revenue_adjustment": 0.1,
      "refunded_revenue": 0.1,
      "gross_revenue": 0.1,
      "post_header_gross_revenue": 0.1,
      "net_revenue": 0.1,
      "post_header_net_revenue": 0.1,
      "tax_rate_id": 1234567891234567,
      "tax_rate": 0.1,
      "gross_tax": 0.1,
      "refunded_tax": 0.1,
      "final_refunded_amount": 0.1,
      "final_tax": 0.1,
      "final_charge": 0.1,
      "refundable_final_charge": 0.1,
      "created": {
        "created_by_id": 1234567891234567,
        "created_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "Updated": {
        "updated_by_id": 1234567891234567,
        "updated_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "invoice_detail_display_type_id": 1234567891234567,
      "fee": 0.1,
      "refunded_fee": 0.1,
      "fee_tax": 0.1
    }
  ]
}