Crunch Invoices API Documentation

Overview

Version information

Version : 0.0.1 [v.1]

Tags

  • PaymentMethodController
  • SalesInvoiceController
  • VatTypeController

Paths

Base URL : https://public-api.crunch.co.uk/v1/invoices

New invoice

POST /

Parameters

Type Name Schema
Body body
optional		 SalesInvoiceDto

Responses

HTTP Code Description Schema
200 success SalesInvoiceDto

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code create:all

Example HTTP request

Request path
/
Request body
{
  "bankAccount" : {
    "bankName" : "string",
    "defaultBankAccount" : true,
    "displayableName" : "string",
    "id" : 0
  },
  "creditNotes" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "lineItems" : [ {
      "amount" : 0.0,
      "description" : "string",
      "id" : 0,
      "itemIndex" : 0
    } ],
    "refunds" : [ {
      "amount" : 0.0,
      "date" : "string",
      "id" : 0,
      "paymentTarget" : {
        "bankAccount" : {
          "bankName" : "string",
          "defaultBankAccount" : true,
          "displayableName" : "string",
          "id" : 0
        },
        "paymentMethod" : {
          "paymentMethodDisplayableName" : "string",
          "paymentMethodName" : "string"
        }
      },
      "reconciled" : true
    } ],
    "state" : "string"
  } ],
  "currency" : "string",
  "customer" : {
    "billingAddress" : {
      "country" : "string",
      "line1" : "string",
      "line2" : "string",
      "line3" : "string",
      "line4" : "string",
      "postCode" : "string"
    },
    "contacts" : [ {
      "email" : "string",
      "id" : 0,
      "includedInEmail" : true,
      "name" : "string",
      "primaryContact" : true,
      "role" : "string",
      "telephone" : "string"
    } ],
    "defaultCurrency" : "string",
    "email" : "string",
    "id" : 0,
    "name" : "string",
    "telephone" : "string"
  },
  "deletable" : true,
  "dueDate" : "string",
  "grossAmount" : 0.0,
  "id" : 0,
  "issuedDate" : "string",
  "items" : [ {
    "amount" : 0.0,
    "description" : "string",
    "id" : 0,
    "priceExclVat" : 0.0,
    "quantity" : 0.0,
    "rate" : 0.0,
    "vatAmountCharged" : 0.0,
    "vatAmountDue" : 0.0,
    "vatRate" : "string"
  } ],
  "lineItemType" : "string",
  "netAmount" : 0.0,
  "note" : {
    "id" : 0,
    "text" : "string"
  },
  "outstandingBalance" : 0.0,
  "payment" : {
    "paymentTerms" : {
      "days" : 0,
      "sendReminders" : true
    }
  },
  "payments" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "paymentTarget" : {
      "bankAccount" : {
        "bankName" : "string",
        "defaultBankAccount" : true,
        "displayableName" : "string",
        "id" : 0
      },
      "paymentMethod" : {
        "paymentMethodDisplayableName" : "string",
        "paymentMethodName" : "string"
      }
    },
    "reconciled" : true
  } ],
  "purchaseOrder" : "string",
  "recurring" : true,
  "reference" : "string",
  "status" : "string",
  "vatAmount" : 0.0
}

Example HTTP response

Response 200
{
  "bankAccount" : {
    "bankName" : "string",
    "defaultBankAccount" : true,
    "displayableName" : "string",
    "id" : 0
  },
  "creditNotes" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "lineItems" : [ {
      "amount" : 0.0,
      "description" : "string",
      "id" : 0,
      "itemIndex" : 0
    } ],
    "refunds" : [ {
      "amount" : 0.0,
      "date" : "string",
      "id" : 0,
      "paymentTarget" : {
        "bankAccount" : {
          "bankName" : "string",
          "defaultBankAccount" : true,
          "displayableName" : "string",
          "id" : 0
        },
        "paymentMethod" : {
          "paymentMethodDisplayableName" : "string",
          "paymentMethodName" : "string"
        }
      },
      "reconciled" : true
    } ],
    "state" : "string"
  } ],
  "currency" : "string",
  "customer" : {
    "billingAddress" : {
      "country" : "string",
      "line1" : "string",
      "line2" : "string",
      "line3" : "string",
      "line4" : "string",
      "postCode" : "string"
    },
    "contacts" : [ {
      "email" : "string",
      "id" : 0,
      "includedInEmail" : true,
      "name" : "string",
      "primaryContact" : true,
      "role" : "string",
      "telephone" : "string"
    } ],
    "defaultCurrency" : "string",
    "email" : "string",
    "id" : 0,
    "name" : "string",
    "telephone" : "string"
  },
  "deletable" : true,
  "dueDate" : "string",
  "grossAmount" : 0.0,
  "id" : 0,
  "issuedDate" : "string",
  "items" : [ {
    "amount" : 0.0,
    "description" : "string",
    "id" : 0,
    "priceExclVat" : 0.0,
    "quantity" : 0.0,
    "rate" : 0.0,
    "vatAmountCharged" : 0.0,
    "vatAmountDue" : 0.0,
    "vatRate" : "string"
  } ],
  "lineItemType" : "string",
  "netAmount" : 0.0,
  "note" : {
    "id" : 0,
    "text" : "string"
  },
  "outstandingBalance" : 0.0,
  "payment" : {
    "paymentTerms" : {
      "days" : 0,
      "sendReminders" : true
    }
  },
  "payments" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "paymentTarget" : {
      "bankAccount" : {
        "bankName" : "string",
        "defaultBankAccount" : true,
        "displayableName" : "string",
        "id" : 0
      },
      "paymentMethod" : {
        "paymentMethodDisplayableName" : "string",
        "paymentMethodName" : "string"
      }
    },
    "reconciled" : true
  } ],
  "purchaseOrder" : "string",
  "recurring" : true,
  "reference" : "string",
  "status" : "string",
  "vatAmount" : 0.0
}

Get a list of invoices for the authenticated client filtering out template invoices

GET /

Description

The default sorting criteria is status,asc,issuedDate,desc,id,desc.

Parameters

Type Name Description Schema Default
Query page
optional		 The index of the page to retrieve, based at 0. integer (int32)
Query size
optional		 Number of records returned per page. Maximum value allowed is 200. integer (int32) 20
Query sort
optional		 Sorting criteria by a given field. < string (<field>[,asc|desc]) > array(multi)

Responses

HTTP Code Description Schema
200 The invoices (if any) for the authenticated client have been found and returned SalesInvoiceStateDtoPage

Produces

  • application/json

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/

Example HTTP response

Response 200
{
  "content" : [ {
    "currency" : "string",
    "customerId" : 0,
    "customerName" : "string",
    "deletable" : true,
    "dueDate" : "string",
    "grossAmount" : 0.0,
    "id" : 0,
    "invoiceNumber" : "string",
    "issuedDate" : "string",
    "netAmount" : 0.0,
    "outstandingBalance" : 0.0,
    "reference" : "string",
    "status" : "string",
    "totalCreditsAmount" : 0.0,
    "vatAmount" : 0.0
  } ],
  "empty" : true,
  "first" : true,
  "last" : true,
  "number" : 0,
  "numberOfElements" : 0,
  "pageable" : {
    "offset" : 0,
    "pageNumber" : 0,
    "pageSize" : 0,
    "paged" : true,
    "sort" : {
      "empty" : true,
      "sorted" : true,
      "unsorted" : true
    },
    "unpaged" : true
  },
  "size" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : true,
    "unsorted" : true
  },
  "totalElements" : 0,
  "totalPages" : 0
}

Get default sales invoice note

GET /default-note

Responses

HTTP Code Description Schema
200 Default sales invoice note successfully returned NoteDto
500 An issue getting default sales invoice note No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/default-note

Example HTTP response

Response 200
{
  "id" : 0,
  "text" : "string"
}

Fetch all payment methods

GET /payment-methods

Parameters

Type Name Schema
Query direction
required		 enum (INBOUND, OUTBOUND)

Responses

HTTP Code Description Schema
200 Payment methods are gathered and put to the body of the response PaymentMethodsDto

Tags

  • PaymentMethodController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/payment-methods?direction=string

Example HTTP response

Response 200
{
  "paymentMethods" : [ {
    "paymentMethodDisplayableName" : "string",
    "paymentMethodName" : "string"
  } ]
}

Get sales invoice totals

GET /sales-invoice-totals

Responses

HTTP Code Description Schema
200 Sales invoice totals successfully returned SalesInvoiceTotalsDto
500 There was an issue getting sales invoice totals No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/sales-invoice-totals

Example HTTP response

Response 200
{
  "emptyState" : true,
  "outstandingTotal" : 0.0,
  "salesTotal" : 0.0
}

Fetch all vat types

GET /vat-types

Responses

HTTP Code Description Schema
200 VAT types are gathered and put to the body of the response VatTypesDto

Tags

  • VatTypeController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/vat-types

Example HTTP response

Response 200
{
  "vatTypes" : [ {
    "displayName" : "string",
    "vatPercent" : 0
  } ]
}

Get invoice

GET /{id}

Parameters

Type Name Schema
Path id
required		 integer (int64)

Responses

HTTP Code Description Schema
200 Invoice is successfully returned SalesInvoiceDto
404 Invoice is not found for customer No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/0

Example HTTP response

Response 200
{
  "bankAccount" : {
    "bankName" : "string",
    "defaultBankAccount" : true,
    "displayableName" : "string",
    "id" : 0
  },
  "creditNotes" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "lineItems" : [ {
      "amount" : 0.0,
      "description" : "string",
      "id" : 0,
      "itemIndex" : 0
    } ],
    "refunds" : [ {
      "amount" : 0.0,
      "date" : "string",
      "id" : 0,
      "paymentTarget" : {
        "bankAccount" : {
          "bankName" : "string",
          "defaultBankAccount" : true,
          "displayableName" : "string",
          "id" : 0
        },
        "paymentMethod" : {
          "paymentMethodDisplayableName" : "string",
          "paymentMethodName" : "string"
        }
      },
      "reconciled" : true
    } ],
    "state" : "string"
  } ],
  "currency" : "string",
  "customer" : {
    "billingAddress" : {
      "country" : "string",
      "line1" : "string",
      "line2" : "string",
      "line3" : "string",
      "line4" : "string",
      "postCode" : "string"
    },
    "contacts" : [ {
      "email" : "string",
      "id" : 0,
      "includedInEmail" : true,
      "name" : "string",
      "primaryContact" : true,
      "role" : "string",
      "telephone" : "string"
    } ],
    "defaultCurrency" : "string",
    "email" : "string",
    "id" : 0,
    "name" : "string",
    "telephone" : "string"
  },
  "deletable" : true,
  "dueDate" : "string",
  "grossAmount" : 0.0,
  "id" : 0,
  "issuedDate" : "string",
  "items" : [ {
    "amount" : 0.0,
    "description" : "string",
    "id" : 0,
    "priceExclVat" : 0.0,
    "quantity" : 0.0,
    "rate" : 0.0,
    "vatAmountCharged" : 0.0,
    "vatAmountDue" : 0.0,
    "vatRate" : "string"
  } ],
  "lineItemType" : "string",
  "netAmount" : 0.0,
  "note" : {
    "id" : 0,
    "text" : "string"
  },
  "outstandingBalance" : 0.0,
  "payment" : {
    "paymentTerms" : {
      "days" : 0,
      "sendReminders" : true
    }
  },
  "payments" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "paymentTarget" : {
      "bankAccount" : {
        "bankName" : "string",
        "defaultBankAccount" : true,
        "displayableName" : "string",
        "id" : 0
      },
      "paymentMethod" : {
        "paymentMethodDisplayableName" : "string",
        "paymentMethodName" : "string"
      }
    },
    "reconciled" : true
  } ],
  "purchaseOrder" : "string",
  "recurring" : true,
  "reference" : "string",
  "status" : "string",
  "vatAmount" : 0.0
}

Update invoice

PUT /{id}

Parameters

Type Name Schema
Path id
required		 integer (int64)
Body body
optional		 SalesInvoiceDto

Responses

HTTP Code Description Schema
200 Invoice is successfully updated SalesInvoiceDto
404 Invoice is not found for customer No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code update:all

Example HTTP request

Request path
/0
Request body
{
  "bankAccount" : {
    "bankName" : "string",
    "defaultBankAccount" : true,
    "displayableName" : "string",
    "id" : 0
  },
  "creditNotes" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "lineItems" : [ {
      "amount" : 0.0,
      "description" : "string",
      "id" : 0,
      "itemIndex" : 0
    } ],
    "refunds" : [ {
      "amount" : 0.0,
      "date" : "string",
      "id" : 0,
      "paymentTarget" : {
        "bankAccount" : {
          "bankName" : "string",
          "defaultBankAccount" : true,
          "displayableName" : "string",
          "id" : 0
        },
        "paymentMethod" : {
          "paymentMethodDisplayableName" : "string",
          "paymentMethodName" : "string"
        }
      },
      "reconciled" : true
    } ],
    "state" : "string"
  } ],
  "currency" : "string",
  "customer" : {
    "billingAddress" : {
      "country" : "string",
      "line1" : "string",
      "line2" : "string",
      "line3" : "string",
      "line4" : "string",
      "postCode" : "string"
    },
    "contacts" : [ {
      "email" : "string",
      "id" : 0,
      "includedInEmail" : true,
      "name" : "string",
      "primaryContact" : true,
      "role" : "string",
      "telephone" : "string"
    } ],
    "defaultCurrency" : "string",
    "email" : "string",
    "id" : 0,
    "name" : "string",
    "telephone" : "string"
  },
  "deletable" : true,
  "dueDate" : "string",
  "grossAmount" : 0.0,
  "id" : 0,
  "issuedDate" : "string",
  "items" : [ {
    "amount" : 0.0,
    "description" : "string",
    "id" : 0,
    "priceExclVat" : 0.0,
    "quantity" : 0.0,
    "rate" : 0.0,
    "vatAmountCharged" : 0.0,
    "vatAmountDue" : 0.0,
    "vatRate" : "string"
  } ],
  "lineItemType" : "string",
  "netAmount" : 0.0,
  "note" : {
    "id" : 0,
    "text" : "string"
  },
  "outstandingBalance" : 0.0,
  "payment" : {
    "paymentTerms" : {
      "days" : 0,
      "sendReminders" : true
    }
  },
  "payments" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "paymentTarget" : {
      "bankAccount" : {
        "bankName" : "string",
        "defaultBankAccount" : true,
        "displayableName" : "string",
        "id" : 0
      },
      "paymentMethod" : {
        "paymentMethodDisplayableName" : "string",
        "paymentMethodName" : "string"
      }
    },
    "reconciled" : true
  } ],
  "purchaseOrder" : "string",
  "recurring" : true,
  "reference" : "string",
  "status" : "string",
  "vatAmount" : 0.0
}

Example HTTP response

Response 200
{
  "bankAccount" : {
    "bankName" : "string",
    "defaultBankAccount" : true,
    "displayableName" : "string",
    "id" : 0
  },
  "creditNotes" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "lineItems" : [ {
      "amount" : 0.0,
      "description" : "string",
      "id" : 0,
      "itemIndex" : 0
    } ],
    "refunds" : [ {
      "amount" : 0.0,
      "date" : "string",
      "id" : 0,
      "paymentTarget" : {
        "bankAccount" : {
          "bankName" : "string",
          "defaultBankAccount" : true,
          "displayableName" : "string",
          "id" : 0
        },
        "paymentMethod" : {
          "paymentMethodDisplayableName" : "string",
          "paymentMethodName" : "string"
        }
      },
      "reconciled" : true
    } ],
    "state" : "string"
  } ],
  "currency" : "string",
  "customer" : {
    "billingAddress" : {
      "country" : "string",
      "line1" : "string",
      "line2" : "string",
      "line3" : "string",
      "line4" : "string",
      "postCode" : "string"
    },
    "contacts" : [ {
      "email" : "string",
      "id" : 0,
      "includedInEmail" : true,
      "name" : "string",
      "primaryContact" : true,
      "role" : "string",
      "telephone" : "string"
    } ],
    "defaultCurrency" : "string",
    "email" : "string",
    "id" : 0,
    "name" : "string",
    "telephone" : "string"
  },
  "deletable" : true,
  "dueDate" : "string",
  "grossAmount" : 0.0,
  "id" : 0,
  "issuedDate" : "string",
  "items" : [ {
    "amount" : 0.0,
    "description" : "string",
    "id" : 0,
    "priceExclVat" : 0.0,
    "quantity" : 0.0,
    "rate" : 0.0,
    "vatAmountCharged" : 0.0,
    "vatAmountDue" : 0.0,
    "vatRate" : "string"
  } ],
  "lineItemType" : "string",
  "netAmount" : 0.0,
  "note" : {
    "id" : 0,
    "text" : "string"
  },
  "outstandingBalance" : 0.0,
  "payment" : {
    "paymentTerms" : {
      "days" : 0,
      "sendReminders" : true
    }
  },
  "payments" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "paymentTarget" : {
      "bankAccount" : {
        "bankName" : "string",
        "defaultBankAccount" : true,
        "displayableName" : "string",
        "id" : 0
      },
      "paymentMethod" : {
        "paymentMethodDisplayableName" : "string",
        "paymentMethodName" : "string"
      }
    },
    "reconciled" : true
  } ],
  "purchaseOrder" : "string",
  "recurring" : true,
  "reference" : "string",
  "status" : "string",
  "vatAmount" : 0.0
}

Delete an invoice

DELETE /{id}

Parameters

Type Name Schema
Path id
required		 integer (int64)

Responses

HTTP Code Description Schema
200 Invoice is successfully deleted integer (int64)
400 Invoice cannot be deleted No Content
404 Invoice cannot be allocated No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code delete:all

Example HTTP request

Request path
/0

Example HTTP response

Response 200
0

Send a sales invoice email

POST /{id}/email

Parameters

Type Name Schema Default
Path id
required		 integer (int64)
Query attachments
optional		 boolean "false"
Body body
optional		 SalesInvoiceEmailDto

Responses

HTTP Code Description Schema
200 Invoice is successfully issued No Content
404 Invoice is not found for customer No Content
500 Internal service error No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code update:all

Example HTTP request

Request path
/0/email
Request body
{
  "emailAddresses" : [ "string" ],
  "message" : "string",
  "subject" : "string"
}

Issue an invoice

POST /{id}/issue

Parameters

Type Name Schema
Path id
required		 integer (int64)

Responses

HTTP Code Description Schema
200 Invoice is successfully issued SalesInvoiceDto
404 Invoice is not found for customer No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code update:all

Example HTTP request

Request path
/0/issue

Example HTTP response

Response 200
{
  "bankAccount" : {
    "bankName" : "string",
    "defaultBankAccount" : true,
    "displayableName" : "string",
    "id" : 0
  },
  "creditNotes" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "lineItems" : [ {
      "amount" : 0.0,
      "description" : "string",
      "id" : 0,
      "itemIndex" : 0
    } ],
    "refunds" : [ {
      "amount" : 0.0,
      "date" : "string",
      "id" : 0,
      "paymentTarget" : {
        "bankAccount" : {
          "bankName" : "string",
          "defaultBankAccount" : true,
          "displayableName" : "string",
          "id" : 0
        },
        "paymentMethod" : {
          "paymentMethodDisplayableName" : "string",
          "paymentMethodName" : "string"
        }
      },
      "reconciled" : true
    } ],
    "state" : "string"
  } ],
  "currency" : "string",
  "customer" : {
    "billingAddress" : {
      "country" : "string",
      "line1" : "string",
      "line2" : "string",
      "line3" : "string",
      "line4" : "string",
      "postCode" : "string"
    },
    "contacts" : [ {
      "email" : "string",
      "id" : 0,
      "includedInEmail" : true,
      "name" : "string",
      "primaryContact" : true,
      "role" : "string",
      "telephone" : "string"
    } ],
    "defaultCurrency" : "string",
    "email" : "string",
    "id" : 0,
    "name" : "string",
    "telephone" : "string"
  },
  "deletable" : true,
  "dueDate" : "string",
  "grossAmount" : 0.0,
  "id" : 0,
  "issuedDate" : "string",
  "items" : [ {
    "amount" : 0.0,
    "description" : "string",
    "id" : 0,
    "priceExclVat" : 0.0,
    "quantity" : 0.0,
    "rate" : 0.0,
    "vatAmountCharged" : 0.0,
    "vatAmountDue" : 0.0,
    "vatRate" : "string"
  } ],
  "lineItemType" : "string",
  "netAmount" : 0.0,
  "note" : {
    "id" : 0,
    "text" : "string"
  },
  "outstandingBalance" : 0.0,
  "payment" : {
    "paymentTerms" : {
      "days" : 0,
      "sendReminders" : true
    }
  },
  "payments" : [ {
    "amount" : 0.0,
    "date" : "string",
    "id" : 0,
    "paymentTarget" : {
      "bankAccount" : {
        "bankName" : "string",
        "defaultBankAccount" : true,
        "displayableName" : "string",
        "id" : 0
      },
      "paymentMethod" : {
        "paymentMethodDisplayableName" : "string",
        "paymentMethodName" : "string"
      }
    },
    "reconciled" : true
  } ],
  "purchaseOrder" : "string",
  "recurring" : true,
  "reference" : "string",
  "status" : "string",
  "vatAmount" : 0.0
}

View invoice pdf

GET /{id}/pdf

Parameters

Type Name Schema
Path id
required		 integer (int64)

Responses

HTTP Code Description Schema
200 Invoice view is successfully returned < string (byte) > array
404 Invoice is not found No Content

Produces

  • application/pdf

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/0/pdf

Example HTTP response

Response 200
[ "string" ]

View invoice state

GET /{id}/state

Parameters

Type Name Schema
Path id
required		 integer (int64)

Responses

HTTP Code Description Schema
200 Invoice state is successfully returned SalesInvoiceStateDto
404 Invoice is not found for customer No Content

Tags

  • SalesInvoiceController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/0/state

Example HTTP response

Response 200
{
  "currency" : "string",
  "customerId" : 0,
  "customerName" : "string",
  "deletable" : true,
  "dueDate" : "string",
  "grossAmount" : 0.0,
  "id" : 0,
  "invoiceNumber" : "string",
  "issuedDate" : "string",
  "netAmount" : 0.0,
  "outstandingBalance" : 0.0,
  "reference" : "string",
  "status" : "string",
  "totalCreditsAmount" : 0.0,
  "vatAmount" : 0.0
}

Definitions

AddressDto

Name Description Schema
country
optional		 Example : "string" string
line1
optional		 Example : "string" string
line2
optional		 Example : "string" string
line3
optional		 Example : "string" string
line4
optional		 Example : "string" string
postCode
optional		 Example : "string" string

BankAccountDto

Name Description Schema
bankName
optional		 Length : 0 - 50
Example : "string"		 string
defaultBankAccount
optional		 Example : true boolean
displayableName
optional		 Example : "string" string
id
optional		 Example : 0 integer (int64)

CreditNoteDto

Name Description Schema
amount
optional		 Example : 0.0 number
date
optional		 Example : "string" string (date)
id
optional		 Example : 0 integer (int64)
lineItems
optional		 Example : [ "[creditnotelineitemdto](#creditnotelineitemdto)" ] < CreditNoteLineItemDto > array
refunds
optional		 Example : [ "[customerpaymentdto](#customerpaymentdto)" ] < CustomerPaymentDto > array
state
optional		 Example : "string" enum (DRAFT, ISSUED, SETTLED)

CreditNoteLineItemDto

Name Description Schema
amount
optional		 Example : 0.0 number
description
optional		 Example : "string" string
id
optional		 Example : 0 integer (int64)
itemIndex
optional		 Example : 0 integer (int32)

CustomerContactDto

Name Description Schema
email
optional		 Example : "string" string
id
optional		 Example : 0 integer (int64)
includedInEmail
optional		 Example : true boolean
name
optional		 Example : "string" string
primaryContact
optional		 Example : true boolean
role
optional		 Example : "string" string
telephone
optional		 Example : "string" string

CustomerDto

Name Description Schema
billingAddress
optional		 Example : "[addressdto](#addressdto)" AddressDto
contacts
optional		 Example : [ "[customercontactdto](#customercontactdto)" ] < CustomerContactDto > array
defaultCurrency
optional		 Example : "string" string
email
optional		 Example : "string" string
id
optional		 Example : 0 integer (int64)
name
optional		 Example : "string" string
telephone
optional		 Example : "string" string

CustomerPaymentDto

Name Description Schema
amount
optional		 Example : 0.0 number
date
optional		 Example : "string" string (date)
id
optional		 Example : 0 integer (int64)
paymentTarget
optional		 Example : "[paymenttargetdto](#paymenttargetdto)" PaymentTargetDto
reconciled
optional		 Example : true boolean

NoteDto

Name Description Schema
id
optional		 Example : 0 integer (int64)
text
optional		 Example : "string" string

Pageable

Name Description Schema
offset
optional		 Example : 0 integer (int64)
pageNumber
optional		 Example : 0 integer (int32)
pageSize
optional		 Example : 0 integer (int32)
paged
optional		 Example : true boolean
sort
optional		 Example : "[sort](#sort)" Sort
unpaged
optional		 Example : true boolean

PaymentDto

Name Description Schema
paymentTerms
optional		 Example : "[paymenttermsdto](#paymenttermsdto)" PaymentTermsDto

PaymentMethodDto

Name Description Schema
paymentMethodDisplayableName
optional		 Example : "string" string
paymentMethodName
optional		 Example : "string" string

PaymentMethodsDto

Name Description Schema
paymentMethods
optional		 Example : [ "[paymentmethoddto](#paymentmethoddto)" ] < PaymentMethodDto > array

PaymentTargetDto

Name Description Schema
bankAccount
optional		 Example : "[bankaccountdto](#bankaccountdto)" BankAccountDto
paymentMethod
optional		 Example : "[paymentmethoddto](#paymentmethoddto)" PaymentMethodDto

PaymentTermsDto

Name Description Schema
days
optional		 Example : 0 integer (int32)
sendReminders
optional		 Example : true boolean

SalesInvoiceDto

Name Description Schema
bankAccount
optional		 Example : "[bankaccountdto](#bankaccountdto)" BankAccountDto
creditNotes
optional		 Example : [ "[creditnotedto](#creditnotedto)" ] < CreditNoteDto > array
currency
optional		 Example : "string" string
customer
optional		 Example : "[customerdto](#customerdto)" CustomerDto
deletable
optional		 Example : true boolean
dueDate
optional		 Example : "string" string (date)
grossAmount
optional		 Example : 0.0 number
id
optional		 Example : 0 integer (int64)
issuedDate
optional		 Example : "string" string (date)
items
optional		 Example : [ "[salesinvoicelineitemdto](#salesinvoicelineitemdto)" ] < SalesInvoiceLineItemDto > array
lineItemType
optional		 Example : "string" enum (SIMPLE, DETAILED)
netAmount
optional		 Example : 0.0 number
note
optional		 Example : "[notedto](#notedto)" NoteDto
outstandingBalance
optional		 Example : 0.0 number
payment
optional		 Example : "[paymentdto](#paymentdto)" PaymentDto
payments
optional		 Example : [ "[customerpaymentdto](#customerpaymentdto)" ] < CustomerPaymentDto > array
purchaseOrder
optional		 Example : "string" string
recurring
optional		 Example : true boolean
reference
optional		 Example : "string" string
status
optional		 Example : "string" string
vatAmount
optional		 Example : 0.0 number

SalesInvoiceEmailDto

Name Description Schema
emailAddresses
optional		 Example : [ "string" ] < string > array
message
optional		 Example : "string" string
subject
optional		 Example : "string" string

SalesInvoiceLineItemDto

Name Description Schema
amount
optional		 Example : 0.0 number
description
optional		 Example : "string" string
id
optional		 Example : 0 integer (int64)
priceExclVat
optional		 Example : 0.0 number
quantity
optional		 Example : 0.0 number
rate
optional		 Example : 0.0 number
vatAmountCharged
optional		 Example : 0.0 number
vatAmountDue
optional		 Example : 0.0 number
vatRate
optional		 Example : "string" string

SalesInvoiceStateDto

Name Description Schema
currency
optional		 Example : "string" enum (AUSTRALIAN_DOLLAR, CANADIAN_DOLLAR, EURO, POUND_STERLING, UNITED_STATES_DOLLAR)
customerId
optional		 Example : 0 integer (int64)
customerName
optional		 Example : "string" string
deletable
optional		 Example : true boolean
dueDate
optional		 Example : "string" string (date)
grossAmount
optional		 Example : 0.0 number
id
optional		 Example : 0 integer (int64)
invoiceNumber
optional		 Example : "string" string
issuedDate
optional		 Example : "string" string (date)
netAmount
optional		 Example : 0.0 number
outstandingBalance
optional		 Example : 0.0 number
reference
optional		 Example : "string" string
status
optional		 Example : "string" string
totalCreditsAmount
optional		 Example : 0.0 number
vatAmount
optional		 Example : 0.0 number

SalesInvoiceStateDtoPage

Name Description Schema
content
optional		 Example : [ "[salesinvoicestatedto](#salesinvoicestatedto)" ] < SalesInvoiceStateDto > array
empty
optional		 Example : true boolean
first
optional		 Example : true boolean
last
optional		 Example : true boolean
number
optional		 Example : 0 integer (int32)
numberOfElements
optional		 Example : 0 integer (int32)
pageable
optional		 Example : "[pageable](#pageable)" Pageable
size
optional		 Example : 0 integer (int32)
sort
optional		 Example : "[sort](#sort)" Sort
totalElements
optional		 Example : 0 integer (int64)
totalPages
optional		 Example : 0 integer (int32)

SalesInvoiceTotalsDto

Name Description Schema
emptyState
optional		 Example : true boolean
outstandingTotal
optional		 Example : 0.0 number
salesTotal
optional		 Example : 0.0 number

Sort

Name Description Schema
empty
optional		 Example : true boolean
sorted
optional		 Example : true boolean
unsorted
optional		 Example : true boolean

VatTypeDto

Name Description Schema
displayName
optional		 Example : "string" string
vatPercent
optional		 Example : 0 integer (int32)

VatTypesDto

Name Description Schema
vatTypes
optional		 Example : [ "[vattypedto](#vattypedto)" ] < VatTypeDto > array