Reference
Queries#
relationAttachment#
Requires: scope relations:read · feature relations.
relationAttachment(id: ID!): RelationAttachment!
| Argument | Type | |
|---|---|---|
id | ID! |
relationPaymentTiming#
How quickly this contact actually pays versus the company median, from settled sales invoices. Use before changing payment terms. Not plan-gated. Newest paid invoices first, capped at 50.
Requires: scope relations:read · feature relations.
relationPaymentTiming(profileId: ID!, relationId: ID!): RelationPaymentTiming!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
relationId | ID! |
relationList#
Requires: scope relations:read · feature relations.
relationList(profileId: ID!, search: String, activity: RelationActivityFilter, kind: RelationKindFilter, first: Int, after: String): RelationListConnection!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
search | String | |
activity | RelationActivityFilter | |
kind | RelationKindFilter | |
first | Int | |
after | String |
relation#
Requires: scope relations:read · feature relations.
relation(id: ID!): Relation!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
relations#
Requires: scope relations:read · feature relations.
relations(paging: CursorPaging!, filter: RelationFilter!, sorting: [RelationSort!]!): RelationConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | RelationFilter! | Specify to filter the records returned. |
sorting | [RelationSort!]! | Specify to sort results. |
relationBankAccount#
Requires: scope relations:read · feature relations.
relationBankAccount(id: ID!): RelationBankAccount!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
relationBankAccounts#
Requires: scope relations:read · feature relations.
relationBankAccounts(paging: CursorPaging!, filter: RelationBankAccountFilter!, sorting: [RelationBankAccountSort!]!): RelationBankAccountConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | RelationBankAccountFilter! | Specify to filter the records returned. |
sorting | [RelationBankAccountSort!]! | Specify to sort results. |
openPurchaseOrdersForRelation#
Purchase orders a supplier can still deliver or invoice against (issued, partially received, received, partially invoiced), oldest first, with their lines and open amount.
Requires: scope relations:read · feature purchase_orders.
openPurchaseOrdersForRelation(relationId: ID!): [PurchaseOrder!]!
| Argument | Type | |
|---|---|---|
relationId | ID! |
relationsSpreadsheetImportTemplate#
Requires: scope relations:read · feature relations.
relationsSpreadsheetImportTemplate(format: SpreadsheetFormat!): SpreadsheetTemplateExport!
| Argument | Type | |
|---|---|---|
format | SpreadsheetFormat! |
exportRelationsSpreadsheet#
Requires: scope relations:read · feature relations.
exportRelationsSpreadsheet(profileId: ID!, format: SpreadsheetFormat!): SpreadsheetTemplateExport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
format | SpreadsheetFormat! |
publicRelationInvoices#
Requires: scope relations:read.
publicRelationInvoices(profileUri: String!, relationId: ID!, token: String): [PublicRelationInvoice!]!
| Argument | Type | |
|---|---|---|
profileUri | String! | |
relationId | ID! | |
token | String |
publicRelation#
Requires: scope relations:read.
publicRelation(profileUri: String!, relationId: ID!, token: String): PublicRelation!
| Argument | Type | |
|---|---|---|
profileUri | String! | |
relationId | ID! | |
token | String |
publicRelationRecurrings#
Requires: scope relations:read.
publicRelationRecurrings(profileUri: String!, relationId: ID!, token: String): [PublicRelationRecurring!]!
| Argument | Type | |
|---|---|---|
profileUri | String! | |
relationId | ID! | |
token | String |
relationRiskFindings#
Open Risk Guard findings on a relation (supplier) and its bank accounts, newest first: which check, severity and what it saw. IBANs are masked. Read-only.
Requires: scope relations:read · feature relations.
relationRiskFindings(relationId: ID!): [RelationRiskFinding!]!
| Argument | Type | |
|---|---|---|
relationId | ID! |
Mutations#
createOneRelationAttachment#
Requires: scope relations:write · feature relations.
createOneRelationAttachment(relationId: ID!, input: CreateRelationAttachmentInput!): RelationAttachment!
| Argument | Type | |
|---|---|---|
relationId | ID! | |
input | CreateRelationAttachmentInput! |
deleteOneRelationAttachment#
Requires: scope relations:write · feature relations.
deleteOneRelationAttachment(input: DeleteOneRelationAttachmentInput!): RelationAttachment!
| Argument | Type | |
|---|---|---|
input | DeleteOneRelationAttachmentInput! |
ensureEmployeeRelation#
Requires: scope relations:write · feature payroll.
ensureEmployeeRelation(employeeId: String!): Employee!
| Argument | Type | |
|---|---|---|
employeeId | String! |
dedupeRelation#
Requires: scope relations:write · feature relations.
dedupeRelation(input: DedupeRelationInput!): Relation!
| Argument | Type | |
|---|---|---|
input | DedupeRelationInput! |
deleteRelation#
Requires: scope relations:write · feature relations.
deleteRelation(id: ID!): ID!
| Argument | Type | |
|---|---|---|
id | ID! |
createOneRelation#
Requires: scope relations:write · feature relations.
createOneRelation(profileId: ID!, input: CreateRelationInput!): Relation!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateRelationInput! |
createManyRelations#
Requires: scope relations:write · feature relations.
createManyRelations(profileId: ID!, input: [CreateRelationInput!]!): [Relation!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateRelationInput!]! |
createOneRelationBankAccount#
Requires: scope relations:write · feature relations.
createOneRelationBankAccount(relationId: ID!, input: CreateRelationBankAccountInput!): RelationBankAccount!
| Argument | Type | |
|---|---|---|
relationId | ID! | |
input | CreateRelationBankAccountInput! |
createManyRelationBankAccounts#
Requires: scope relations:write · feature relations.
createManyRelationBankAccounts(relationId: ID!, input: [CreateRelationBankAccountInput!]!): [RelationBankAccount!]!
| Argument | Type | |
|---|---|---|
relationId | ID! | |
input | [CreateRelationBankAccountInput!]! |
updateOneRelation#
Requires: scope relations:write · feature relations.
updateOneRelation(input: UpdateOneRelationInput!): Relation!
| Argument | Type | |
|---|---|---|
input | UpdateOneRelationInput! |
updateManyRelations#
Requires: scope relations:write · feature relations.
updateManyRelations(input: UpdateManyRelationsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyRelationsInput! |
deleteOneRelation#
Requires: scope relations:write · feature relations.
deleteOneRelation(input: DeleteOneRelationInput!): RelationDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneRelationInput! |
deleteManyRelations#
Requires: scope relations:write · feature relations.
deleteManyRelations(input: DeleteManyRelationsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyRelationsInput! |
updateOneRelationBankAccount#
Requires: scope relations:write · feature relations.
updateOneRelationBankAccount(input: UpdateOneRelationBankAccountInput!): RelationBankAccount!
| Argument | Type | |
|---|---|---|
input | UpdateOneRelationBankAccountInput! |
updateManyRelationBankAccounts#
Requires: scope relations:write · feature relations.
updateManyRelationBankAccounts(input: UpdateManyRelationBankAccountsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyRelationBankAccountsInput! |
deleteOneRelationBankAccount#
Requires: scope relations:write · feature relations.
deleteOneRelationBankAccount(input: DeleteOneRelationBankAccountInput!): RelationBankAccountDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneRelationBankAccountInput! |
deleteManyRelationBankAccounts#
Requires: scope relations:write · feature relations.
deleteManyRelationBankAccounts(input: DeleteManyRelationBankAccountsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyRelationBankAccountsInput! |
importRelationsSpreadsheet#
Requires: scope relations:write · feature relations.
importRelationsSpreadsheet(profileId: ID!, format: SpreadsheetFormat!, file: String!): SpreadsheetImportResult!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
format | SpreadsheetFormat! | |
file | String! |
createOneEnterpriseProfileRelation#
Requires: scope relations:write · feature relations.
createOneEnterpriseProfileRelation(input: CreateOneEnterpriseProfileRelationInput!): EnterpriseProfileRelation!
| Argument | Type | |
|---|---|---|
input | CreateOneEnterpriseProfileRelationInput! |
createManyEnterpriseProfileRelations#
Requires: scope relations:write · feature relations.
createManyEnterpriseProfileRelations(input: CreateManyEnterpriseProfileRelationsInput!): [EnterpriseProfileRelation!]!
| Argument | Type | |
|---|---|---|
input | CreateManyEnterpriseProfileRelationsInput! |
updateOneEnterpriseProfileRelation#
Requires: scope relations:write · feature relations.
updateOneEnterpriseProfileRelation(input: UpdateOneEnterpriseProfileRelationInput!): EnterpriseProfileRelation!
| Argument | Type | |
|---|---|---|
input | UpdateOneEnterpriseProfileRelationInput! |
updateManyEnterpriseProfileRelations#
Requires: scope relations:write · feature relations.
updateManyEnterpriseProfileRelations(input: UpdateManyEnterpriseProfileRelationsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyEnterpriseProfileRelationsInput! |
deleteOneEnterpriseProfileRelation#
Requires: scope relations:write · feature relations.
deleteOneEnterpriseProfileRelation(input: DeleteOneEnterpriseProfileRelationInput!): EnterpriseProfileRelationDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneEnterpriseProfileRelationInput! |
deleteManyEnterpriseProfileRelations#
Requires: scope relations:write · feature relations.
deleteManyEnterpriseProfileRelations(input: DeleteManyEnterpriseProfileRelationsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyEnterpriseProfileRelationsInput! |
saveClientOnboardingContact#
Requires: scope relations:write.
saveClientOnboardingContact(token: String!, input: ClientOnboardingContactInput!): PublicClientOnboardingInvite!
| Argument | Type | |
|---|---|---|
token | String! | |
input | ClientOnboardingContactInput! |