Reference
Queries#
overpaidSalesInvoiceIds#
Requires: scope sales_invoices:read · feature sales_invoices.
overpaidSalesInvoiceIds(profileId: ID!): [ID!]!
| Argument | Type | |
|---|---|---|
profileId | ID! |
salesInvoiceAttachment#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceAttachment(id: ID!): SalesInvoiceAttachment!
| Argument | Type | |
|---|---|---|
id | ID! |
salesInvoiceEvent#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceEvent(id: ID!): SalesInvoiceEvent!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
salesInvoiceEvents#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceEvents(paging: CursorPaging!, filter: SalesInvoiceEventFilter!, sorting: [SalesInvoiceEventSort!]!): SalesInvoiceEventConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | SalesInvoiceEventFilter! | Specify to filter the records returned. |
sorting | [SalesInvoiceEventSort!]! | Specify to sort results. |
salesInvoiceNote#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceNote(id: ID!): SalesInvoiceNote!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
salesInvoiceNotes#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceNotes(paging: CursorPaging!, filter: SalesInvoiceNoteFilter!, sorting: [SalesInvoiceNoteSort!]!): SalesInvoiceNoteConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | SalesInvoiceNoteFilter! | Specify to filter the records returned. |
sorting | [SalesInvoiceNoteSort!]! | Specify to sort results. |
salesInvoiceLine#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceLine(id: ID!): SalesInvoiceLine!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
salesInvoiceLines#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceLines(paging: CursorPaging!, filter: SalesInvoiceLineFilter!, sorting: [SalesInvoiceLineSort!]!): SalesInvoiceLineConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | SalesInvoiceLineFilter! | Specify to filter the records returned. |
sorting | [SalesInvoiceLineSort!]! | Specify to sort results. |
salesInvoice#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoice(id: ID!): SalesInvoice!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
salesInvoices#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoices(paging: CursorPaging!, filter: SalesInvoiceFilter!, sorting: [SalesInvoiceSort!]!): SalesInvoiceConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | SalesInvoiceFilter! | Specify to filter the records returned. |
sorting | [SalesInvoiceSort!]! | Specify to sort results. |
salesInvoiceLayoutPreviewHtml#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoiceLayoutPreviewHtml(profileId: ID!, layoutJson: String, logo: String): String!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
layoutJson | String | |
logo | String |
practiceSalesInvoicePreview#
Requires: scope sales_invoices:read · feature sales_invoices.
practiceSalesInvoicePreview(profileId: ID!): PracticeSalesInvoicePreview!
| Argument | Type | |
|---|---|---|
profileId | ID! |
salesInvoicesSpreadsheetImportTemplate#
Requires: scope sales_invoices:read · feature sales_invoices.
salesInvoicesSpreadsheetImportTemplate(format: SpreadsheetFormat!): SpreadsheetTemplateExport!
| Argument | Type | |
|---|---|---|
format | SpreadsheetFormat! |
exportSalesInvoicesSpreadsheet#
Requires: scope sales_invoices:read · feature sales_invoices.
exportSalesInvoicesSpreadsheet(profileId: ID!, format: SpreadsheetFormat!): SpreadsheetTemplateExport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
format | SpreadsheetFormat! |
publicSalesInvoice#
Requires: scope sales_invoices:read.
publicSalesInvoice(profileUri: String!, invoiceId: ID!, token: String): PublicSalesInvoice!
| Argument | Type | |
|---|---|---|
profileUri | String! | |
invoiceId | ID! | |
token | String |
Mutations#
closeSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
closeSalesInvoice(id: ID!, send: Boolean): SalesInvoice!
| Argument | Type | |
|---|---|---|
id | ID! | |
send | Boolean |
setSalesInvoiceExternalId#
Requires: scope sales_invoices:write · feature sales_invoices.
setSalesInvoiceExternalId(id: ID!, externalId: String!): SalesInvoice!
| Argument | Type | |
|---|---|---|
id | ID! | |
externalId | String! |
reopenSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
reopenSalesInvoice(id: ID!): SalesInvoice!
| Argument | Type | |
|---|---|---|
id | ID! |
creditSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
creditSalesInvoice(id: ID!, close: Boolean): SalesInvoice!
| Argument | Type | |
|---|---|---|
id | ID! | |
close | Boolean |
duplicateSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
duplicateSalesInvoice(id: ID!): SalesInvoice!
| Argument | Type | |
|---|---|---|
id | ID! |
applySalesInvoiceDocumentDiscount#
Requires: scope sales_invoices:write · feature sales_invoices.
applySalesInvoiceDocumentDiscount(input: ApplySalesInvoiceDocumentDiscountInput!): SalesInvoice!
| Argument | Type | |
|---|---|---|
input | ApplySalesInvoiceDocumentDiscountInput! |
removeSalesInvoiceDocumentDiscount#
Requires: scope sales_invoices:write · feature sales_invoices.
removeSalesInvoiceDocumentDiscount(input: RemoveSalesInvoiceDocumentDiscountInput!): SalesInvoice!
| Argument | Type | |
|---|---|---|
input | RemoveSalesInvoiceDocumentDiscountInput! |
assignProjectToSalesInvoices#
Requires: scope sales_invoices:write · feature projects.
assignProjectToSalesInvoices(input: AssignProjectToSalesInvoicesInput!): AssignProjectToSalesInvoicesResult!
| Argument | Type | |
|---|---|---|
input | AssignProjectToSalesInvoicesInput! |
createOneSalesInvoiceAttachment#
Requires: scope sales_invoices:write · feature sales_invoices.
createOneSalesInvoiceAttachment(salesInvoiceId: ID!, input: CreateSalesInvoiceAttachmentInput!): SalesInvoiceAttachment!
| Argument | Type | |
|---|---|---|
salesInvoiceId | ID! | |
input | CreateSalesInvoiceAttachmentInput! |
updateOneSalesInvoiceAttachment#
Requires: scope sales_invoices:write · feature sales_invoices.
updateOneSalesInvoiceAttachment(input: UpdateOneSalesInvoiceAttachmentInput!): SalesInvoiceAttachment!
| Argument | Type | |
|---|---|---|
input | UpdateOneSalesInvoiceAttachmentInput! |
deleteOneSalesInvoiceAttachment#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteOneSalesInvoiceAttachment(input: DeleteOneSalesInvoiceAttachmentInput!): SalesInvoiceAttachment!
| Argument | Type | |
|---|---|---|
input | DeleteOneSalesInvoiceAttachmentInput! |
createOneSalesInvoiceEvent#
Requires: scope sales_invoices:write · feature sales_invoices.
createOneSalesInvoiceEvent(salesInvoiceId: ID!, input: CreateSalesInvoiceEventInput!): SalesInvoiceEvent!
| Argument | Type | |
|---|---|---|
salesInvoiceId | ID! | |
input | CreateSalesInvoiceEventInput! |
createManySalesInvoiceEvents#
Requires: scope sales_invoices:write · feature sales_invoices.
createManySalesInvoiceEvents(salesInvoiceId: ID!, input: [CreateSalesInvoiceEventInput!]!): [SalesInvoiceEvent!]!
| Argument | Type | |
|---|---|---|
salesInvoiceId | ID! | |
input | [CreateSalesInvoiceEventInput!]! |
createOneSalesInvoiceNote#
Requires: scope sales_invoices:write · feature sales_invoices.
createOneSalesInvoiceNote(salesInvoiceId: ID!, input: CreateSalesInvoiceNoteInput!): SalesInvoiceNote!
| Argument | Type | |
|---|---|---|
salesInvoiceId | ID! | |
input | CreateSalesInvoiceNoteInput! |
createManySalesInvoiceNotes#
Requires: scope sales_invoices:write · feature sales_invoices.
createManySalesInvoiceNotes(salesInvoiceId: ID!, input: [CreateSalesInvoiceNoteInput!]!): [SalesInvoiceNote!]!
| Argument | Type | |
|---|---|---|
salesInvoiceId | ID! | |
input | [CreateSalesInvoiceNoteInput!]! |
createOneSalesInvoiceLine#
Requires: scope sales_invoices:write · feature sales_invoices.
createOneSalesInvoiceLine(salesInvoiceId: ID!, input: CreateSalesInvoiceLineInput!): SalesInvoiceLine!
| Argument | Type | |
|---|---|---|
salesInvoiceId | ID! | |
input | CreateSalesInvoiceLineInput! |
createManySalesInvoiceLines#
Requires: scope sales_invoices:write · feature sales_invoices.
createManySalesInvoiceLines(salesInvoiceId: ID!, input: [CreateSalesInvoiceLineInput!]!): [SalesInvoiceLine!]!
| Argument | Type | |
|---|---|---|
salesInvoiceId | ID! | |
input | [CreateSalesInvoiceLineInput!]! |
createOneSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
createOneSalesInvoice(profileId: ID!, input: CreateSalesInvoiceInput!): SalesInvoice!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateSalesInvoiceInput! |
createManySalesInvoices#
Requires: scope sales_invoices:write · feature sales_invoices.
createManySalesInvoices(profileId: ID!, input: [CreateSalesInvoiceInput!]!): [SalesInvoice!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateSalesInvoiceInput!]! |
updateOneSalesInvoiceEvent#
Requires: scope sales_invoices:write · feature sales_invoices.
updateOneSalesInvoiceEvent(input: UpdateOneSalesInvoiceEventInput!): SalesInvoiceEvent!
| Argument | Type | |
|---|---|---|
input | UpdateOneSalesInvoiceEventInput! |
updateManySalesInvoiceEvents#
Requires: scope sales_invoices:write · feature sales_invoices.
updateManySalesInvoiceEvents(input: UpdateManySalesInvoiceEventsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManySalesInvoiceEventsInput! |
deleteOneSalesInvoiceEvent#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteOneSalesInvoiceEvent(input: DeleteOneSalesInvoiceEventInput!): SalesInvoiceEventDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneSalesInvoiceEventInput! |
deleteManySalesInvoiceEvents#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteManySalesInvoiceEvents(input: DeleteManySalesInvoiceEventsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManySalesInvoiceEventsInput! |
updateOneSalesInvoiceNote#
Requires: scope sales_invoices:write · feature sales_invoices.
updateOneSalesInvoiceNote(input: UpdateOneSalesInvoiceNoteInput!): SalesInvoiceNote!
| Argument | Type | |
|---|---|---|
input | UpdateOneSalesInvoiceNoteInput! |
updateManySalesInvoiceNotes#
Requires: scope sales_invoices:write · feature sales_invoices.
updateManySalesInvoiceNotes(input: UpdateManySalesInvoiceNotesInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManySalesInvoiceNotesInput! |
deleteOneSalesInvoiceNote#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteOneSalesInvoiceNote(input: DeleteOneSalesInvoiceNoteInput!): SalesInvoiceNoteDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneSalesInvoiceNoteInput! |
deleteManySalesInvoiceNotes#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteManySalesInvoiceNotes(input: DeleteManySalesInvoiceNotesInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManySalesInvoiceNotesInput! |
updateOneSalesInvoiceLine#
Requires: scope sales_invoices:write · feature sales_invoices.
updateOneSalesInvoiceLine(input: UpdateOneSalesInvoiceLineInput!): SalesInvoiceLine!
| Argument | Type | |
|---|---|---|
input | UpdateOneSalesInvoiceLineInput! |
updateManySalesInvoiceLines#
Requires: scope sales_invoices:write · feature sales_invoices.
updateManySalesInvoiceLines(input: UpdateManySalesInvoiceLinesInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManySalesInvoiceLinesInput! |
deleteOneSalesInvoiceLine#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteOneSalesInvoiceLine(input: DeleteOneSalesInvoiceLineInput!): SalesInvoiceLineDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneSalesInvoiceLineInput! |
deleteManySalesInvoiceLines#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteManySalesInvoiceLines(input: DeleteManySalesInvoiceLinesInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManySalesInvoiceLinesInput! |
updateOneSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
updateOneSalesInvoice(input: UpdateOneSalesInvoiceInput!): SalesInvoice!
| Argument | Type | |
|---|---|---|
input | UpdateOneSalesInvoiceInput! |
updateManySalesInvoices#
Requires: scope sales_invoices:write · feature sales_invoices.
updateManySalesInvoices(input: UpdateManySalesInvoicesInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManySalesInvoicesInput! |
deleteOneSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteOneSalesInvoice(input: DeleteOneSalesInvoiceInput!): SalesInvoiceDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneSalesInvoiceInput! |
deleteManySalesInvoices#
Requires: scope sales_invoices:write · feature sales_invoices.
deleteManySalesInvoices(input: DeleteManySalesInvoicesInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManySalesInvoicesInput! |
convertQuoteToSalesInvoice#
Requires: scope sales_invoices:write · feature quotes.
convertQuoteToSalesInvoice(id: ID!): SalesInvoice!
| Argument | Type | |
|---|---|---|
id | ID! |
writeOffSalesInvoicePaymentDifference#
Requires: scope sales_invoices:write · feature sales_invoices.
writeOffSalesInvoicePaymentDifference(profileId: ID!, salesInvoiceId: ID!, ledgerId: String): Settlement!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
salesInvoiceId | ID! | |
ledgerId | String |
sendPracticeSalesInvoice#
Requires: scope sales_invoices:write · feature sales_invoices.
sendPracticeSalesInvoice(profileId: ID!): PracticeSalesInvoiceResult!
| Argument | Type | |
|---|---|---|
profileId | ID! |
importSalesInvoicesSpreadsheet#
Requires: scope sales_invoices:write · feature sales_invoices.
importSalesInvoicesSpreadsheet(profileId: ID!, format: SpreadsheetFormat!, file: String!): SpreadsheetImportResult!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
format | SpreadsheetFormat! | |
file | String! |
markSalesInvoiceUncollectible#
Mark a closed sales invoice as uncollectible (bad debt) or undo it. Feeds VAT bad-debt relief checks; does not book anything.
Requires: scope sales_invoices:write · feature sales_invoices.
markSalesInvoiceUncollectible(id: ID!, uncollectible: Boolean!, note: String, vatReliefClaimed: Boolean): Boolean!
| Argument | Type | |
|---|---|---|
id | ID! | |
uncollectible | Boolean! | |
note | String | |
vatReliefClaimed | Boolean |