Version : 0.0.1 [v.1]
https://public-api.crunch.co.uk/v1/invoices
get /attachments
update:all
""
application/json
get /payment-methods
read:all
{
"paymentMethods" : [ {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}, {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
} ]
}
application/json
delete /{id}
delete:all
0
application/json
get /
status,asc
,issuedDate,desc
,id,desc
.read:all
{
"number" : 4,
"size" : 1,
"last" : true,
"numberOfElements" : 1,
"totalPages" : 0,
"pageable" : {
"paged" : true,
"pageNumber" : 1,
"offset" : 7,
"pageSize" : 1,
"unpaged" : true
},
"sort" : {
"unsorted" : true,
"sorted" : true,
"empty" : true
},
"content" : [ {
"issuedDate" : "2000-01-23",
"netAmount" : 2.3021358869347655,
"dueDate" : "2000-01-23",
"deletable" : true,
"grossAmount" : 9.301444243932576,
"totalCreditsAmount" : 2.027123023002322,
"customerName" : "customerName",
"vatAmount" : 7.061401241503109,
"reference" : "reference",
"invoiceNumber" : "invoiceNumber",
"customerId" : 5,
"currency" : "AUSTRALIAN_DOLLAR",
"id" : 5,
"status" : "status",
"outstandingBalance" : 3.616076749251911
}, {
"issuedDate" : "2000-01-23",
"netAmount" : 2.3021358869347655,
"dueDate" : "2000-01-23",
"deletable" : true,
"grossAmount" : 9.301444243932576,
"totalCreditsAmount" : 2.027123023002322,
"customerName" : "customerName",
"vatAmount" : 7.061401241503109,
"reference" : "reference",
"invoiceNumber" : "invoiceNumber",
"customerId" : 5,
"currency" : "AUSTRALIAN_DOLLAR",
"id" : 5,
"status" : "status",
"outstandingBalance" : 3.616076749251911
} ],
"first" : true,
"totalElements" : 6,
"empty" : true
}
application/json
get /default-note
read:all
{
"id" : 4,
"text" : "text"
}
application/json
get /filtered-totals
read:all
{
"invoicedSum" : 0.8008281904610115,
"owedByYouSum" : 1.4658129805029452,
"owedToYouSum" : 6.027456183070403
}
application/json
get /sales-invoice-totals
read:all
{
"emptyState" : true,
"outstandingTotal" : 6.027456183070403,
"salesTotal" : 0.8008281904610115
}
application/json
get /{id}/pdf
read:all
""
application/pdf
get /{id}
read:all
{
"issuedDate" : "2000-01-23",
"note" : {
"id" : 4,
"text" : "text"
},
"attachments" : [ {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
}, {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
} ],
"netAmount" : 5.962133916683182,
"recurring" : true,
"dueDate" : "2000-01-23",
"payments" : [ {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
}, {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
} ],
"deletable" : true,
"grossAmount" : 2.3021358869347655,
"vatAmount" : 5.637376656633329,
"reference" : "reference",
"creditNotes" : [ {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
}, {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
} ],
"lineItemType" : "SIMPLE",
"purchaseOrder" : "purchaseOrder",
"currency" : "currency",
"payment" : {
"paymentTerms" : {
"sendReminders" : true,
"days" : 9
}
},
"id" : 0,
"items" : [ {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
}, {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
} ],
"customer" : {
"defaultCurrency" : "defaultCurrency",
"name" : "name",
"telephone" : "telephone",
"id" : 6,
"billingAddress" : {
"country" : "country",
"line4" : "line4",
"postCode" : "postCode",
"line3" : "line3",
"line2" : "line2",
"line1" : "line1"
},
"email" : "email",
"contacts" : [ {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
}, {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
} ]
},
"status" : "status",
"outstandingBalance" : 7.061401241503109
}
application/json
get /{id}/state
read:all
{
"issuedDate" : "2000-01-23",
"netAmount" : 2.3021358869347655,
"dueDate" : "2000-01-23",
"deletable" : true,
"grossAmount" : 9.301444243932576,
"totalCreditsAmount" : 2.027123023002322,
"customerName" : "customerName",
"vatAmount" : 7.061401241503109,
"reference" : "reference",
"invoiceNumber" : "invoiceNumber",
"customerId" : 5,
"currency" : "AUSTRALIAN_DOLLAR",
"id" : 5,
"status" : "status",
"outstandingBalance" : 3.616076749251911
}
application/json
post /{id}/issue
update:all
{
"issuedDate" : "2000-01-23",
"note" : {
"id" : 4,
"text" : "text"
},
"attachments" : [ {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
}, {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
} ],
"netAmount" : 5.962133916683182,
"recurring" : true,
"dueDate" : "2000-01-23",
"payments" : [ {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
}, {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
} ],
"deletable" : true,
"grossAmount" : 2.3021358869347655,
"vatAmount" : 5.637376656633329,
"reference" : "reference",
"creditNotes" : [ {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
}, {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
} ],
"lineItemType" : "SIMPLE",
"purchaseOrder" : "purchaseOrder",
"currency" : "currency",
"payment" : {
"paymentTerms" : {
"sendReminders" : true,
"days" : 9
}
},
"id" : 0,
"items" : [ {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
}, {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
} ],
"customer" : {
"defaultCurrency" : "defaultCurrency",
"name" : "name",
"telephone" : "telephone",
"id" : 6,
"billingAddress" : {
"country" : "country",
"line4" : "line4",
"postCode" : "postCode",
"line3" : "line3",
"line2" : "line2",
"line1" : "line1"
},
"email" : "email",
"contacts" : [ {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
}, {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
} ]
},
"status" : "status",
"outstandingBalance" : 7.061401241503109
}
application/json
post /
application/json
create:all
{
"issuedDate" : "2000-01-23",
"note" : {
"id" : 4,
"text" : "text"
},
"attachments" : [ {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
}, {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
} ],
"netAmount" : 5.962133916683182,
"recurring" : true,
"dueDate" : "2000-01-23",
"payments" : [ {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
}, {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
} ],
"deletable" : true,
"grossAmount" : 2.3021358869347655,
"vatAmount" : 5.637376656633329,
"reference" : "reference",
"creditNotes" : [ {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
}, {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
} ],
"lineItemType" : "SIMPLE",
"purchaseOrder" : "purchaseOrder",
"currency" : "currency",
"payment" : {
"paymentTerms" : {
"sendReminders" : true,
"days" : 9
}
},
"id" : 0,
"items" : [ {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
}, {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
} ],
"customer" : {
"defaultCurrency" : "defaultCurrency",
"name" : "name",
"telephone" : "telephone",
"id" : 6,
"billingAddress" : {
"country" : "country",
"line4" : "line4",
"postCode" : "postCode",
"line3" : "line3",
"line2" : "line2",
"line1" : "line1"
},
"email" : "email",
"contacts" : [ {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
}, {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
} ]
},
"status" : "status",
"outstandingBalance" : 7.061401241503109
}
application/json
post /{id}/email
application/json
update:all
put /{id}
application/json
update:all
{
"issuedDate" : "2000-01-23",
"note" : {
"id" : 4,
"text" : "text"
},
"attachments" : [ {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
}, {
"fileName" : "fileName",
"id" : 9,
"fileContents" : "fileContents"
} ],
"netAmount" : 5.962133916683182,
"recurring" : true,
"dueDate" : "2000-01-23",
"payments" : [ {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
}, {
"paymentTarget" : {
"bankAccount" : {
"defaultBankAccount" : true,
"bankName" : "bankName",
"displayableName" : "displayableName",
"id" : 7
},
"paymentMethod" : {
"paymentMethodName" : "paymentMethodName",
"paymentMethodDisplayableName" : "paymentMethodDisplayableName"
}
},
"date" : "2000-01-23",
"amount" : 1.1730742509559433,
"reconciled" : true,
"id" : 6
} ],
"deletable" : true,
"grossAmount" : 2.3021358869347655,
"vatAmount" : 5.637376656633329,
"reference" : "reference",
"creditNotes" : [ {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
}, {
"date" : "2000-01-23",
"lineItems" : [ {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
}, {
"amount" : 6.683562403749608,
"itemIndex" : 9,
"description" : "description",
"id" : 9
} ],
"amount" : 8.762042012749001,
"id" : 5,
"state" : "DRAFT",
"refunds" : [ null, null ]
} ],
"lineItemType" : "SIMPLE",
"purchaseOrder" : "purchaseOrder",
"currency" : "currency",
"payment" : {
"paymentTerms" : {
"sendReminders" : true,
"days" : 9
}
},
"id" : 0,
"items" : [ {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
}, {
"priceExclVat" : 2.027123023002322,
"amount" : 4.145608029883936,
"quantity" : 1.2315135367772556,
"vatAmountDue" : 1.4894159098541704,
"rate" : 7.386281948385884,
"vatRate" : "vatRate",
"description" : "description",
"vatAmountCharged" : 1.0246457001441578,
"id" : 3
} ],
"customer" : {
"defaultCurrency" : "defaultCurrency",
"name" : "name",
"telephone" : "telephone",
"id" : 6,
"billingAddress" : {
"country" : "country",
"line4" : "line4",
"postCode" : "postCode",
"line3" : "line3",
"line2" : "line2",
"line1" : "line1"
},
"email" : "email",
"contacts" : [ {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
}, {
"role" : "role",
"includedInEmail" : true,
"primaryContact" : true,
"name" : "name",
"telephone" : "telephone",
"id" : 1,
"email" : "email"
} ]
},
"status" : "status",
"outstandingBalance" : 7.061401241503109
}
application/json
get /vat-types
read:all
{
"vatTypes" : [ {
"displayName" : "displayName",
"vatPercent" : 0
}, {
"displayName" : "displayName",
"vatPercent" : 0
} ]
}
application/json
AddressDto
BankAccountDto
CreditNoteDto
CreditNoteLineItemDto
CustomerContactDto
CustomerDto
CustomerPaymentDto
NoteDto
Pageable
PaymentDto
PaymentMethodDto
PaymentMethodsDto
PaymentTargetDto
PaymentTermsDto
Resource
SalesInvoiceAttachmentDto
SalesInvoiceDto
SalesInvoiceEmailDto
SalesInvoiceFilteredTotalsDto
SalesInvoiceLineItemDto
SalesInvoiceStateDto
SalesInvoiceStateDtoPage
SalesInvoiceTotalsDto
Sort
VatTypeDto
VatTypesDto
CreditNoteDto
UpCreditNoteLineItemDto
UpCustomerDto
UpCustomerPaymentDto
UpPaymentDto
UpPaymentMethodsDto
UpSalesInvoiceDto
UpSalesInvoiceFilteredTotalsDto
UpSalesInvoiceLineItemDto
UpSalesInvoiceStateDto
UpSalesInvoiceStateDtoPage
UpVatTypesDto
Up