DESCRIPTION
Only for subscribers using Scheduled Invoicing. This endpoint returns a list of scheduled invoices that are due to be sent today.
URL STRUCTURE
https://[hostname]/finance/invoice/scheduled/get-today
METHOD
GET
HEADERS
**Authorization:** string Base64 [email]:[key]
RETURNS
A json array of any invoices scheduled to be sent today.
[
{
"id": null,
"legalEntityId": 25,
"locationId": 177697,
"templateId": 21684,
"matterId": null,
"relatedPreview": null,
"vatRate": 0.2,
"invoiceDate": null,
"paymentDate": null,
"billGuideNumber": null,
"billGuideNumberChargeTable": null,
"invoiceNumber": null,
"status": null,
"partPaid": null,
"amount": 100,
"amountCurrency": 0,
"VATAmount": 20,
"VATAmountCurrency": 0,
"workingInAmount": 100,
"workingInVATAmount": 20,
"workingInCurrency": "",
"workingInCurrencyRate": 1,
"baseCurrencyAmount": 100,
"baseCurrencyVATAmount": 20,
"currency": "pound",
"currencyRate": 0,
"currencyMarkup": 0,
"invoiceProductionSettings": {},
"autoInvoiceSettings": null,
"taxCodeId": null,
"tax1Total": null,
"tax2Total": null,
"tax3Total": null,
"workingInTax1Total": null,
"workingInTax2Total": null,
"workingInTax3Total": null,
"currencyTax1Total": null,
"currencyTax2Total": null,
"currencyTax3Total": null,
"matterCache": null,
"setupDate": null,
"charges": [
{
"id": "1387935",
"orgId": "204",
"userId": "3685",
"teamId": "0",
"matterUserId": "3685",
"matterId": "877320",
"time": "60",
"date": {
"date": "2024-12-30 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"billDate": "0000-00-00 00:00:00",
"description": "Preparing and filing statement of inventorship",
"legalEntityId": "0",
"category": "Time",
"subCategory": "1",
"paymentReference": "",
"supportingDocId": "0",
"notes": "",
"status": {
"statusValue": "approved"
},
"amount": "100",
"adjustment": "0",
"discount": "0",
"discountPercentage": "0",
"chargeRate": "100",
"chargeRateCurrency": "",
"currency": "",
"currencyAmount": "0",
"currencyRate": "0",
"currencyMarkup": "0",
"currencyCharge": "0",
"workingInCurrency": "",
"workingInAmount": "100",
"workingInAdjustment": "0",
"workingInDiscount": "0",
"workingInCurrencyRate": "1",
"billed": "0",
"potentialForVAT": "1",
"billGuideNumber": "0",
"invoiceNumber": "",
"previewId": "0",
"adjustmentReason": "",
"writeOffReason": "",
"discountReason": "",
"chargeSheetId": "1115",
"setupBy": "3685",
"setupDateTime": null,
"chargeSheetEntry": null,
"disableSaving": false,
"multiplier": "0",
"discountRuleAppliedId": "0",
"discountRuleObject": null,
"invoiceAmount": "100.00",
"vatAmount": 20,
"vatCurrencyAmount": null,
"debitLedgerCode": null,
"creditLedgerCode": null,
"nonChargeable": "0",
"isRenewalCharge": "0",
"associatedLocation": "0",
"parentChargeId": "0",
"paidDate": "0000-00-00 00:00:00",
"paidByUs": "0",
"invoiceCache": {
"id": null,
"legalEntityId": null,
"locationId": null,
"templateId": null,
"matterId": null,
"relatedPreview": null,
"vatRate": null,
"invoiceDate": null,
"paymentDate": null,
"billGuideNumber": null,
"billGuideNumberChargeTable": -1,
"invoiceNumber": null,
"status": null,
"partPaid": null,
"amount": null,
"amountCurrency": null,
"VATAmount": null,
"VATAmountCurrency": null,
"workingInAmount": null,
"workingInVATAmount": null,
"workingInCurrency": null,
"workingInCurrencyRate": null,
"baseCurrencyAmount": null,
"baseCurrencyVATAmount": null,
"currency": null,
"currencyRate": null,
"currencyMarkup": null,
"invoiceProductionSettings": null,
"autoInvoiceSettings": null,
"taxCodeId": null,
"tax1Total": null,
"tax2Total": null,
"tax3Total": null,
"workingInTax1Total": null,
"workingInTax2Total": null,
"workingInTax3Total": null,
"currencyTax1Total": null,
"currencyTax2Total": null,
"currencyTax3Total": null,
"matterCache": null,
"setupDate": null,
"charges": [],
"location": {
"id": null,
"organisationId": null,
"categories": [],
"type": null,
"name": null,
"legalName": null,
"address": null,
"street1": null,
"street2": null,
"street3": null,
"city": null,
"county": null,
"postCode": null,
"country": null,
"website": null,
"phone": null,
"phone2": null,
"phone3": null,
"email": null,
"email2": null,
"email3": null,
"notes": null,
"extraCareNotes": null,
"extraCareNotesColor": null,
"setupDateTime": null,
"setupByUser": null,
"modifiedDateTime": null,
"modifiedByUser": null,
"active": null,
"VATNumber": null,
"badPayer": null,
"taxCode": null,
"exportCode": null,
"oldId": null,
"companyNumber": null,
"bankAccount": null,
"matterToSaveInvoicesOn": null,
"accountsContactId": null,
"entityType": "location",
"invoiceSettings": null,
"defaultCurrency": null,
"taxRounding": null,
"customFields": [],
"addressString": ""
},
"fileContent": null,
"pdfFileContent": null,
"credited": null,
"creditReason": null,
"creditNoteId": null
},
"multiCurrency": {},
"invoiceCurrency": {},
"showTextInInvoice": "0",
"budgetCache": null,
"entityType": "charge",
"customFields": [
{
"id": 27,
"name": "Agent Invoice Number",
"type": "text",
"value": "",
"entityType": "charge",
"required": 0,
"possibleValues": [],
"defaultValue": "",
"inheritFromParent": 0,
"fieldNameAppend": null
}
],
"modifiedBy": "3685",
"modifiedDateTime": "2024-12-30 16:01:32"
}
],
"location": {
"id": "177697",
"organisationId": "167699",
"categories": [
{
"name": "Correspondence",
"id": 1
},
{
"name": "Visiting",
"id": 2
},
{
"name": "Billing",
"id": 3
},
{
"name": "Creditor",
"id": 4
},
{
"name": "Renewal Correspondence",
"id": 5
},
{
"name": "Renewal Billing",
"id": 6
}
],
"type": "",
"name": "Black Labrador Associates (USD)",
"legalName": "",
"address": "123 Hillberry Blues Lane\r\nPints\r\nAnywhere\r\n3VR 3YWR",
"street1": "123 Hillberry Blues Lane",
"street2": "",
"street3": "",
"city": "Pints",
"county": "Anywhere",
"postCode": "3VR 3YWR",
"country": "US",
"website": "",
"phone": "255555",
"phone2": "",
"phone3": "",
"email": "[email protected]",
"email2": "",
"email3": "",
"notes": "notes",
"extraCareNotes": "",
"extraCareNotesColor": "",
"setupDateTime": "",
"setupByUser": "3685",
"modifiedDateTime": "",
"modifiedByUser": "3685",
"active": "1",
"VATNumber": "",
"badPayer": "1",
"taxCode": "0",
"exportCode": "123",
"oldId": "",
"companyNumber": "",
"bankAccount": "",
"matterToSaveInvoicesOn": "877475",
"accountsContactId": "153438",
"entityType": "location",
"invoiceSettings": {
"locationId": 177697,
"repeatFrequency": null,
"repeatUnit": "daily",
"startDate": {
"date": "2021-04-22 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"dayOfWeek": 4,
"dayOfMonth": 22,
"lastDayOfMonth": 0,
"mode": "combined",
"templateId": 21684,
"currency": "",
"VATmode": "on",
"deliveryMethod": "email",
"taskUser": "matter-1",
"language": "",
"isUpfrontPayer": 0,
"autoAdjustToOriginalCurrencyAmount": 1,
"billingContact": 153367,
"renewalBillingContact": 153367,
"paymentTerm": "60 days",
"notesForFinanceWizard": "",
"badDebtor": 1,
"paymentPlan": 2,
"defaultWorkingInCurrency": "",
"billingContactObject": null,
"renewalBillingContactObject": null,
"userObject": null,
"location": null,
"forceRenewalsBillSplit": 1,
"attachSupportingDocumentsSingle": 0,
"attachSupportingDocumentsCombined": 0
},
"defaultCurrency": "EUR",
"taxRounding": "",
"customFields": {
{
"id": 90,
"name": "Invoice Name (External Facing)",
"type": "text",
"value": "",
"entityType": "location",
"required": 0,
"possibleValues": [],
"defaultValue": "",
"inheritFromParent": 0,
"fieldNameAppend": null
},
],
"addressString": "123 Hillberry Blues Lane,<br>Pints,<br>Anywhere,<br>3VR 3YWR,<br>United States of America"
},
"fileContent": null,
"pdfFileContent": null,
"credited": null,
"creditReason": null,
"creditNoteId": null
},
{
"id": null,
"legalEntityId": 0,
"locationId": 177651,
"templateId": 21682,
"matterId": null,
"relatedPreview": null,
"vatRate": null,
"invoiceDate": null,
"paymentDate": null,
"billGuideNumber": null,
"billGuideNumberChargeTable": null,
"invoiceNumber": null,
"status": null,
"partPaid": null,
"amount": 210,
"amountCurrency": 0,
"VATAmount": 0,
"VATAmountCurrency": 0,
"workingInAmount": 210,
"workingInVATAmount": 0,
"workingInCurrency": "",
"workingInCurrencyRate": 1,
"baseCurrencyAmount": 210,
"baseCurrencyVATAmount": 0,
"currency": "pound",
"currencyRate": 0,
"currencyMarkup": 0,
"invoiceProductionSettings": {},
"autoInvoiceSettings": null,
"taxCodeId": null,
"tax1Total": null,
"tax2Total": null,
"tax3Total": null,
"workingInTax1Total": null,
"workingInTax2Total": null,
"workingInTax3Total": null,
"currencyTax1Total": null,
"currencyTax2Total": null,
"currencyTax3Total": null,
"matterCache": null,
"setupDate": null,
"charges": [
{
"id": "1387686",
"orgId": "204",
"userId": "3671",
"teamId": "3907",
"matterUserId": "3701",
"matterId": "877604",
"time": "0",
"date": {
"date": "2024-11-20 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"billDate": "0000-00-00 00:00:00",
"description": "Service Charge - Renewals - 5th Patent Annuity",
"legalEntityId": "0",
"category": "Fixed",
"subCategory": "24",
"paymentReference": "",
"supportingDocId": "0",
"notes": "",
"status": {
"statusValue": "approved"
},
"amount": "110",
"adjustment": "0",
"discount": "0",
"discountPercentage": "0",
"chargeRate": "0",
"chargeRateCurrency": "",
"currency": "",
"currencyAmount": "0",
"currencyRate": "0",
"currencyMarkup": "0",
"currencyCharge": "0",
"workingInCurrency": "",
"workingInAmount": "110",
"workingInAdjustment": "0",
"workingInDiscount": "0",
"workingInCurrencyRate": "1",
"billed": "0",
"potentialForVAT": "1",
"billGuideNumber": "0",
"invoiceNumber": "",
"previewId": "0",
"adjustmentReason": "",
"writeOffReason": "",
"discountReason": "",
"chargeSheetId": "1774",
"setupBy": "0",
"setupDateTime": null,
"chargeSheetEntry": null,
"disableSaving": false,
"multiplier": "0",
"discountRuleAppliedId": "0",
"discountRuleObject": null,
"invoiceAmount": "110.00",
"vatAmount": 0,
"vatCurrencyAmount": null,
"debitLedgerCode": null,
"creditLedgerCode": null,
"nonChargeable": "0",
"isRenewalCharge": "1",
"associatedLocation": "0",
"parentChargeId": "0",
"paidDate": "0000-00-00 00:00:00",
"paidByUs": "0",
"invoiceCache": {
"id": null,
"legalEntityId": null,
"locationId": null,
"templateId": null,
"matterId": null,
"relatedPreview": null,
"vatRate": null,
"invoiceDate": null,
"paymentDate": null,
"billGuideNumber": null,
"billGuideNumberChargeTable": -1,
"invoiceNumber": null,
"status": null,
"partPaid": null,
"amount": null,
"amountCurrency": null,
"VATAmount": null,
"VATAmountCurrency": null,
"workingInAmount": null,
"workingInVATAmount": null,
"workingInCurrency": null,
"workingInCurrencyRate": null,
"baseCurrencyAmount": null,
"baseCurrencyVATAmount": null,
"currency": null,
"currencyRate": null,
"currencyMarkup": null,
"invoiceProductionSettings": null,
"autoInvoiceSettings": null,
"taxCodeId": null,
"tax1Total": null,
"tax2Total": null,
"tax3Total": null,
"workingInTax1Total": null,
"workingInTax2Total": null,
"workingInTax3Total": null,
"currencyTax1Total": null,
"currencyTax2Total": null,
"currencyTax3Total": null,
"matterCache": null,
"setupDate": null,
"charges": [],
"location": {
"id": null,
"organisationId": null,
"categories": [],
"type": null,
"name": null,
"legalName": null,
"address": null,
"street1": null,
"street2": null,
"street3": null,
"city": null,
"county": null,
"postCode": null,
"country": null,
"website": null,
"phone": null,
"phone2": null,
"phone3": null,
"email": null,
"email2": null,
"email3": null,
"notes": null,
"extraCareNotes": null,
"extraCareNotesColor": null,
"setupDateTime": null,
"setupByUser": null,
"modifiedDateTime": null,
"modifiedByUser": null,
"active": null,
"VATNumber": null,
"badPayer": null,
"taxCode": null,
"exportCode": null,
"oldId": null,
"companyNumber": null,
"bankAccount": null,
"matterToSaveInvoicesOn": null,
"accountsContactId": null,
"entityType": "location",
"invoiceSettings": null,
"defaultCurrency": null,
"taxRounding": null,
"customFields": [],
"addressString": ""
},
"fileContent": null,
"pdfFileContent": null,
"credited": null,
"creditReason": null,
"creditNoteId": null
},
"multiCurrency": {},
"invoiceCurrency": {},
"showTextInInvoice": "1",
"budgetCache": null,
"entityType": "charge",
"customFields": [
{
"id": 27,
"name": "Agent Invoice Number",
"type": "text",
"value": "",
"entityType": "charge",
"required": 0,
"possibleValues": [],
"defaultValue": "",
"inheritFromParent": 0,
"fieldNameAppend": null
},
],
"modifiedBy": "",
"modifiedDateTime": ""
},
{
"id": "1387687",
"orgId": "204",
"userId": "3671",
"teamId": "3907",
"matterUserId": "3701",
"matterId": "877604",
"time": "0",
"date": {
"date": "2024-11-20 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"billDate": "0000-00-00 00:00:00",
"description": "Renewals - Disbursement",
"legalEntityId": "0",
"category": "Cost",
"subCategory": "57",
"paymentReference": "",
"supportingDocId": "0",
"notes": "",
"status": {
"statusValue": "approved"
},
"amount": "100",
"adjustment": "0",
"discount": "0",
"discountPercentage": "0",
"chargeRate": "0",
"chargeRateCurrency": "",
"currency": "",
"currencyAmount": "0",
"currencyRate": "0",
"currencyMarkup": "0",
"currencyCharge": "0",
"workingInCurrency": "",
"workingInAmount": "100",
"workingInAdjustment": "0",
"workingInDiscount": "0",
"workingInCurrencyRate": "1",
"billed": "0",
"potentialForVAT": "1",
"billGuideNumber": "0",
"invoiceNumber": "",
"previewId": "0",
"adjustmentReason": "",
"writeOffReason": "",
"discountReason": "",
"chargeSheetId": "848",
"setupBy": "0",
"setupDateTime": null,
"chargeSheetEntry": null,
"disableSaving": false,
"multiplier": "0",
"discountRuleAppliedId": "0",
"discountRuleObject": null,
"invoiceAmount": "100.00",
"vatAmount": 0,
"vatCurrencyAmount": null,
"debitLedgerCode": null,
"creditLedgerCode": null,
"nonChargeable": "0",
"isRenewalCharge": "1",
"associatedLocation": "0",
"parentChargeId": "0",
"paidDate": "0000-00-00 00:00:00",
"paidByUs": "0",
"invoiceCache": {
"id": null,
"legalEntityId": null,
"locationId": null,
"templateId": null,
"matterId": null,
"relatedPreview": null,
"vatRate": null,
"invoiceDate": null,
"paymentDate": null,
"billGuideNumber": null,
"billGuideNumberChargeTable": -1,
"invoiceNumber": null,
"status": null,
"partPaid": null,
"amount": null,
"amountCurrency": null,
"VATAmount": null,
"VATAmountCurrency": null,
"workingInAmount": null,
"workingInVATAmount": null,
"workingInCurrency": null,
"workingInCurrencyRate": null,
"baseCurrencyAmount": null,
"baseCurrencyVATAmount": null,
"currency": null,
"currencyRate": null,
"currencyMarkup": null,
"invoiceProductionSettings": null,
"autoInvoiceSettings": null,
"taxCodeId": null,
"tax1Total": null,
"tax2Total": null,
"tax3Total": null,
"workingInTax1Total": null,
"workingInTax2Total": null,
"workingInTax3Total": null,
"currencyTax1Total": null,
"currencyTax2Total": null,
"currencyTax3Total": null,
"matterCache": null,
"setupDate": null,
"charges": [],
"location": {
"id": null,
"organisationId": null,
"categories": [],
"type": null,
"name": null,
"legalName": null,
"address": null,
"street1": null,
"street2": null,
"street3": null,
"city": null,
"county": null,
"postCode": null,
"country": null,
"website": null,
"phone": null,
"phone2": null,
"phone3": null,
"email": null,
"email2": null,
"email3": null,
"notes": null,
"extraCareNotes": null,
"extraCareNotesColor": null,
"setupDateTime": null,
"setupByUser": null,
"modifiedDateTime": null,
"modifiedByUser": null,
"active": null,
"VATNumber": null,
"badPayer": null,
"taxCode": null,
"exportCode": null,
"oldId": null,
"companyNumber": null,
"bankAccount": null,
"matterToSaveInvoicesOn": null,
"accountsContactId": null,
"entityType": "location",
"invoiceSettings": null,
"defaultCurrency": null,
"taxRounding": null,
"customFields": [],
"addressString": ""
},
"fileContent": null,
"pdfFileContent": null,
"credited": null,
"creditReason": null,
"creditNoteId": null
},
"multiCurrency": {},
"invoiceCurrency": {},
"showTextInInvoice": "0",
"budgetCache": null,
"entityType": "charge",
"customFields": [
{
"id": 27,
"name": "Agent Invoice Number",
"type": "text",
"value": "",
"entityType": "charge",
"required": 0,
"possibleValues": [],
"defaultValue": "",
"inheritFromParent": 0,
"fieldNameAppend": null
},
],
"modifiedBy": "",
"modifiedDateTime": ""
}
],
"location": {
"id": "177651",
"organisationId": "167655",
"categories": [
{
"name": "Correspondence",
"id": 1
},
{
"name": "Visiting",
"id": 2
},
{
"name": "Billing",
"id": 3
},
{
"name": "Creditor",
"id": 4
},
{
"name": "Renewal Correspondence",
"id": 5
},
{
"name": "Renewal Billing",
"id": 6
}
],
"type": "",
"name": "D Office",
"legalName": "",
"address": "",
"street1": "",
"street2": "",
"street3": "",
"city": "",
"county": "",
"postCode": "",
"country": "GB",
"website": "",
"phone": "",
"phone2": "",
"phone3": "",
"email": "",
"email2": "",
"email3": "",
"notes": "",
"extraCareNotes": "",
"extraCareNotesColor": "",
"setupDateTime": "2020-09-25 14:54:45",
"setupByUser": "2663",
"modifiedDateTime": "2020-09-25 14:54:45",
"modifiedByUser": "2663",
"active": "1",
"VATNumber": "",
"badPayer": "1",
"taxCode": "0",
"exportCode": "",
"oldId": "",
"companyNumber": "",
"bankAccount": "",
"matterToSaveInvoicesOn": "0",
"accountsContactId": "0",
"entityType": "location",
"invoiceSettings": {
"locationId": 177651,
"repeatFrequency": null,
"repeatUnit": "daily",
"startDate": {
"date": "2021-04-01 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"dayOfWeek": 4,
"dayOfMonth": 1,
"lastDayOfMonth": 1,
"mode": "combined",
"templateId": 21682,
"currency": "",
"VATmode": "auto",
"deliveryMethod": "task",
"taskUser": "3674",
"language": "",
"isUpfrontPayer": 0,
"autoAdjustToOriginalCurrencyAmount": 0,
"billingContact": 153414,
"renewalBillingContact": 153414,
"paymentTerm": "30 days",
"notesForFinanceWizard": "",
"badDebtor": 1,
"paymentPlan": null,
"defaultWorkingInCurrency": "",
"billingContactObject": null,
"renewalBillingContactObject": null,
"userObject": null,
"location": null,
"forceRenewalsBillSplit": 0,
"attachSupportingDocumentsSingle": 0,
"attachSupportingDocumentsCombined": 0
},
"defaultCurrency": "EUR",
"taxRounding": "",
"customFields": [
{
"id": 90,
"name": "Invoice Name (External Facing)",
"type": "text",
"value": "",
"entityType": "location",
"required": 0,
"possibleValues": [],
"defaultValue": "",
"inheritFromParent": 0,
"fieldNameAppend": null
}
],
"addressString": "United Kingdom"
},
"fileContent": null,
"pdfFileContent": null,
"credited": null,
"creditReason": null,
"creditNoteId": null
}
]