Invoices Page


Overview

Returns the data available on the invoices and payments page.


GET /en/invoices

Gets the data representing the invoices and payments page

GET /en/invoices
Parameters: none
{
  "Invoices": [
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000043",
      "PaymentReference": "C287964677000043",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "EovZfEtBhnlawSAtjr1o3QfNv5p / 63",
      "BillToCountry": {},
      "Description": "General (Jon Doe)",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-26T17:14:45",
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "TotalAmount": 12.1,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-23T17:14:45",
      "Currency": {},
      "TaxAmount": 2.1,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-23T17:15:39",
      "Lines": [
        {}
      ],
      "LinesPaged": [
        [
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$12.10",
      "TaxAmountFormated": "$2.10",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 358604485,
      "IdString": "358604485",
      "UpdatedOn": "2017-03-23T22:15:41",
      "UniqueId": "a373f881-c884-45a6-8aef-47334b0af8c7",
      "IsNull": false
    },
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000040",
      "PaymentReference": "C287964677000040",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "8D2nkO6aQ0qtgVHzN4v9TFMlUXi / 46",
      "BillToCountry": {},
      "Description": "General (Jon Doe), General (Jon Doe)",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-24T07:47:10",
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "TotalAmount": 24.2,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-21T07:47:10",
      "Currency": {},
      "TaxAmount": 4.2,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-21T07:49:29",
      "Lines": [
        {},
        {}
      ],
      "LinesPaged": [
        [
          {},
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$24.20",
      "TaxAmountFormated": "$4.20",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 353648516,
      "IdString": "353648516",
      "UpdatedOn": "2017-03-21T12:49:31",
      "UniqueId": "7a6c0dd5-fb6a-4c03-9b10-e4e3e3d1f599",
      "IsNull": false
    },
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000039",
      "PaymentReference": "C287964677000039",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "KPtfIA7iNdUT6fVonLg7RYBVIoj / 49",
      "BillToCountry": {},
      "Description": "Flexible Sat-Sun Desk Membership, Prorated Membership. 11 days.",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-24T07:31:17",
      "InvoiceFromDate": "2017-03-21T00:00:00",
      "InvoiceToDate": "2017-04-01T00:00:00",
      "TotalAmount": 42.93,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-21T07:31:18",
      "Currency": {},
      "TaxAmount": 7.45,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-21T07:49:28",
      "Lines": [
        {},
        {}
      ],
      "LinesPaged": [
        [
          {},
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$42.93",
      "TaxAmountFormated": "$7.45",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 353648508,
      "IdString": "353648508",
      "UpdatedOn": "2017-03-21T12:49:31",
      "UniqueId": "44afe0a4-b205-4be2-860e-075ef2fb28e7",
      "IsNull": false
    }
  ],
  "ThisSpaceInvoices": [
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000043",
      "PaymentReference": "C287964677000043",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "EovZfEtBhnlawSAtjr1o3QfNv5p / 63",
      "BillToCountry": {},
      "Description": "General (Jon Doe)",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-26T17:14:45",
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "TotalAmount": 12.1,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-23T17:14:45",
      "Currency": {},
      "TaxAmount": 2.1,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-23T17:15:39",
      "Lines": [
        {}
      ],
      "LinesPaged": [
        [
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$12.10",
      "TaxAmountFormated": "$2.10",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 358604485,
      "IdString": "358604485",
      "UpdatedOn": "2017-03-23T22:15:41",
      "UniqueId": "a373f881-c884-45a6-8aef-47334b0af8c7",
      "IsNull": false
    },
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000040",
      "PaymentReference": "C287964677000040",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "8D2nkO6aQ0qtgVHzN4v9TFMlUXi / 46",
      "BillToCountry": {},
      "Description": "General (Jon Doe), General (Jon Doe)",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-24T07:47:10",
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "TotalAmount": 24.2,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-21T07:47:10",
      "Currency": {},
      "TaxAmount": 4.2,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-21T07:49:29",
      "Lines": [
        {},
        {}
      ],
      "LinesPaged": [
        [
          {},
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$24.20",
      "TaxAmountFormated": "$4.20",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 353648516,
      "IdString": "353648516",
      "UpdatedOn": "2017-03-21T12:49:31",
      "UniqueId": "7a6c0dd5-fb6a-4c03-9b10-e4e3e3d1f599",
      "IsNull": false
    },
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000039",
      "PaymentReference": "C287964677000039",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "KPtfIA7iNdUT6fVonLg7RYBVIoj / 49",
      "BillToCountry": {},
      "Description": "Flexible Sat-Sun Desk Membership, Prorated Membership. 11 days.",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-24T07:31:17",
      "InvoiceFromDate": "2017-03-21T00:00:00",
      "InvoiceToDate": "2017-04-01T00:00:00",
      "TotalAmount": 42.93,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-21T07:31:18",
      "Currency": {},
      "TaxAmount": 7.45,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-21T07:49:28",
      "Lines": [
        {},
        {}
      ],
      "LinesPaged": [
        [
          {},
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$42.93",
      "TaxAmountFormated": "$7.45",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 353648508,
      "IdString": "353648508",
      "UpdatedOn": "2017-03-21T12:49:31",
      "UniqueId": "44afe0a4-b205-4be2-860e-075ef2fb28e7",
      "IsNull": false
    }
  ],
  "PaidInvoices": [
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000043",
      "PaymentReference": "C287964677000043",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "EovZfEtBhnlawSAtjr1o3QfNv5p / 63",
      "BillToCountry": {},
      "Description": "General (Jon Doe)",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-26T17:14:45",
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "TotalAmount": 12.1,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-23T17:14:45",
      "Currency": {},
      "TaxAmount": 2.1,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-23T17:15:39",
      "Lines": [
        {}
      ],
      "LinesPaged": [
        [
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$12.10",
      "TaxAmountFormated": "$2.10",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 358604485,
      "IdString": "358604485",
      "UpdatedOn": "2017-03-23T22:15:41",
      "UniqueId": "a373f881-c884-45a6-8aef-47334b0af8c7",
      "IsNull": false
    },
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000040",
      "PaymentReference": "C287964677000040",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "8D2nkO6aQ0qtgVHzN4v9TFMlUXi / 46",
      "BillToCountry": {},
      "Description": "General (Jon Doe), General (Jon Doe)",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-24T07:47:10",
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "TotalAmount": 24.2,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-21T07:47:10",
      "Currency": {},
      "TaxAmount": 4.2,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-21T07:49:29",
      "Lines": [
        {},
        {}
      ],
      "LinesPaged": [
        [
          {},
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$24.20",
      "TaxAmountFormated": "$4.20",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 353648516,
      "IdString": "353648516",
      "UpdatedOn": "2017-03-21T12:49:31",
      "UniqueId": "7a6c0dd5-fb6a-4c03-9b10-e4e3e3d1f599",
      "IsNull": false
    },
    {
      "Coworker": {},
      "Business": {},
      "InvoiceNumber": "C287964677000039",
      "PaymentReference": "C287964677000039",
      "BillToName": "Jon Doe",
      "BillToAddress": "Not Available",
      "BillToCity": "Not Available",
      "BillToPostCode": "Not Available",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToTaxIDNumber": null,
      "TaxIDNumber": null,
      "CustomData": "KPtfIA7iNdUT6fVonLg7RYBVIoj / 49",
      "BillToCountry": {},
      "Description": "Flexible Sat-Sun Desk Membership, Prorated Membership. 11 days.",
      "PurchaseOrder": "",
      "DiscountAmount": 0,
      "DueDate": "2017-03-24T07:31:17",
      "InvoiceFromDate": "2017-03-21T00:00:00",
      "InvoiceToDate": "2017-04-01T00:00:00",
      "TotalAmount": 42.93,
      "TransactionTotalAmount": 0,
      "TransactionCurrency": {},
      "CreatedOn": "2017-03-21T07:31:18",
      "Currency": {},
      "TaxAmount": 7.45,
      "Paid": true,
      "Draft": false,
      "PaidOn": "2017-03-21T07:49:28",
      "Lines": [
        {},
        {}
      ],
      "LinesPaged": [
        [
          {},
          {}
        ]
      ],
      "Payments": [
        {}
      ],
      "TaxCategories": [
        {}
      ],
      "TotalFormated": "$42.93",
      "TaxAmountFormated": "$7.45",
      "DiscountAmountFormated": "$0.00",
      "TransactionTotalAmountFormatted": "$0.00",
      "ForteSignature": null,
      "EpaySingature": null,
      "Id": 353648508,
      "IdString": "353648508",
      "UpdatedOn": "2017-03-21T12:49:31",
      "UniqueId": "44afe0a4-b205-4be2-860e-075ef2fb28e7",
      "IsNull": false
    }
  ],
  "UnPaidInvoices": [],
  "ThisSpaceUnPaidInvoices": [],
  "TotalUnpaidAmount": 0,
  "HasUnpaidInvoices": false,
  "PayPalEnabled": false,
  "StripeEnabled": false,
  "StripePublicKey": "dghdgh",
  "USAEPayEnabled": false,
  "AdyenEnabled": false,
  "CanPrintInvoices": true,
  "SpreedlyEnvironmentKey": "OwBV9UpahWwFdOFTEFrLNqAavZk",
  "SpreedlyEnabled": true,
  "MultiGatewayEnabled": true,
  "CurrentBalance": 0,
  "UtcTimeTicks": "636259069324834474",
  "ForteEnabled": false,
  "ForteCCEnable": false,
  "ForteECheckEnabled": false,
  "ForteApiLoginId": null,
  "EpayEnabled": false,
  "EPayMerchant": "",
  "BraintreeEnabled": false,
  "BraintreeClientToken": null,
  "BraintreePublicKey": "",
  "KeepNewAccountsOnHold": false
}

POST /en/invoices/TryPayment/{id}

Attempts to pay an invoice using the payment details stored in the Coworker record.

POST /en/invoices/TryPayment
Parameters:
id: the id of the invoice to attempt payment for
{
  "Status": 200, 
  "Message": "Invoice C287964677000001 was paid.",
  "Errors": null,
  "WasSuccessful": true
}

GET /en/invoices/Print?guid={guid}

Returns the bytes of the PDF version of an invoice

GET /en/invoices/Print/?guid={guid}
Parameters:
guid: the UniqueID of the invoice to return the PDF bytes for

GET /en/invoices/Statement

Returns the bytes of the PDF statement for the logged in user

GET /en/invoices/Statement
Parameters:none

GET /en/invoices/Draft

Returns the bytes of the PDF version of the next invoice for the logged in user

GET /en/invoices/Draft
Parameters:none


Source: XML ! RSS