RelatieDocumenten |
Geeft alle beschikbare relaties (RelatieModel) terug uit een administratie. Op deze operatie is OData functionaliteit beschikbaar.Voor deze operatie zijn de volgende scopes benodigd:- relaties:read
Catalogus: SnelStart
Schema: Handel
Dit is een alleen-lezen tabelfunctie. De SnelStart API biedt mogelijk geen ondersteuning voor het wijzigen van de data of het Invantive SQL-stuurprogramma voor SnelStart ondersteunt dit niet. In het laatste geval gebruikt u de tabel NativePlatformScalarRequests om gegevens te uploaden naar de SnelStart-API.
Parameters van de tabelfunctie
De volgende parameters kunnen worden gebruikt om het gedrag van de tabelfunctie RelatieDocumenten in te stellen. Voor verplichte parameters moet altijd een waarde worden opgegeven, maar optionele parameters hoeven in het algemeen geen waarde te hebben en de uitvoering zal standaard een vooraf bepaald gedrag vertonen. Waarden kunnen worden gespecificeerd op basis van positie en naam. In beide gevallen worden alle niet-gespecificeerde parameters geëvalueerd aan de hand van hun standaardwaarden.
Waardespecificatie op positie gebeurt door alle waarden van de eerste tot de laatste benodigde waarde op te sommen. Bijvoorbeeld: een `select * uit tabel(waarde1, waarde2, waarde3)` op een tabel met vier parameters zal de standaardwaarde voor de vierde parameter gebruiken en de opgegeven waarden voor de eerste drie.
Waardespecificatie op naam gebeurt door alle waarden die een waarde vereisen op te sommen. Bijvoorbeeld met `selecteer * uit tabel(naam1 => waarde1, naam3 => waarde3)` op dezelfde tabel zullen de standaardwaarden voor de tweede en vierde parameter worden gebruikt en de opgegeven waarden voor de eerste en derde.
Naam |
Datatype |
Verplicht |
Standaardwaarde |
Documentatie |
---|---|---|---|---|
$expand |
string |
☐ |
|
OData expand, zie http://docs.oasis-open.org/odata/odata/v4.01/cs01/part2-url-conventions/odata-v4.01-cs01-part2-url-conventions.html#sec_SystemQueryOptionexpand |
$filter |
string |
☐ |
|
OData filter, zie http://docs.oasis-open.org/odata/odata/v4.01/cs01/part2-url-conventions/odata-v4.01-cs01-part2-url-conventions.html#sec_SystemQueryOptionfilter |
$skip |
int64 |
☐ |
|
Format - int32. Het aantal resultaten dat overgeslagen wordt. |
$top |
int64 |
☐ |
|
Format - int32. Het maximum aantal resultaten. |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie RelatieDocumenten worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
---|---|---|---|---|
aanmaningEmailVersturen_ccEmail |
string |
Herinnering CC E-mail |
☐ |
Het (optionele) email adres waarnaar email moeten worden ge-Cc-eed. |
aanmaningEmailVersturen_email |
string |
Herinnering E-mail |
☐ |
Het email adres waarnaar email moeten worden verstuurd. |
aanmaningEmailVersturen_shouldSend |
boolean |
Herinnering E-mail Verzenden |
☐ |
Geeft aan (lezen/schrijven) of er email moet worden verstuurd. |
aanmaningsoort |
string |
Herinneringsoort |
☐ |
Het soort aanmaning ({SnelStart.B2B.Api.V2.Models.Relaties.AanmaningsoortModel}) dat van toepassing is op de relatie (optioneel). |
bankieren |
boolean |
Bankieren |
☐ |
Geeft <see langword="true" /> terug als {SnelStart.B2B.Api.V2.Models.Relaties.RelatieModel.IncassoSoort}{SnelStart.B2B.Api.V2.Models.Relaties.IncassosoortModel.Core} of {SnelStart.B2B.Api.V2.Models.Relaties.IncassosoortModel.B2B} is.Dit veld komt overeen met het veld Betaalopdracht in SnelStart Desktop |
bestellingEmailVersturen_ccEmail |
string |
Inkoop CC E-mail |
☐ |
Het (optionele) email adres waarnaar email moeten worden ge-Cc-eed. |
bestellingEmailVersturen_email |
string |
Inkoop E-mail |
☐ |
Het email adres waarnaar email moeten worden verstuurd. |
bestellingEmailVersturen_shouldSend |
boolean |
Inkoop E-mail Sturen |
☐ |
Geeft aan (lezen/schrijven) of er email moet worden verstuurd. |
bevestigingsEmailVersturen_ccEmail |
string |
Bevestiging CC E-mail |
☐ |
Het (optionele) email adres waarnaar email moeten worden ge-Cc-eed. |
bevestigingsEmailVersturen_email |
string |
Bevestiging E-mail |
☐ |
Het email adres waarnaar email moeten worden verstuurd. |
bevestigingsEmailVersturen_shouldSend |
boolean |
Bevestiging E-mail Sturen |
☐ |
Geeft aan (lezen/schrijven) of er email moet worden verstuurd. |
bic |
string(15) |
BIC |
☐ |
De BIC-code van de bank van het {SnelStart.B2B.Api.V2.Models.Relaties.RelatieModel.Iban}-nummer. |
btwNummer |
string |
BTW-nummer |
☐ |
Het BTW-nummer van de relatie. |
correspondentieAdres_contactpersoon |
string |
Postadres Contactpersoon |
☐ |
De volledige naam van de contactpersoon op dit adres. |
correspondentieAdres_plaats |
string |
Postadres Stad |
☐ |
De plaatsnaam van het adres. |
correspondentieAdres_postcode |
string |
Postadres Postcode |
☐ |
De postcode van het adres. |
correspondentieAdres_straat |
string |
Postadres Straat |
☐ |
De straatnaam (inclusief huisnummer). |
string |
☐ |
Het hoofd-emailadres van de relatie. |
||
factuurEmailVersturen_ccEmail |
string |
Factuur CC E-mail |
☐ |
Het (optionele) email adres waarnaar email moeten worden ge-Cc-eed. |
factuurEmailVersturen_email |
string |
Factuur E-mail |
☐ |
Het email adres waarnaar email moeten worden verstuurd. |
factuurEmailVersturen_shouldSend |
boolean |
Factuur E-mail Sturen |
☐ |
Geeft aan (lezen/schrijven) of er email moet worden verstuurd. |
factuurkorting |
double |
Factuurkorting |
☐ |
De standaard factuurkorting die aan deze relatie wordt gegeven (optioneel). |
factuurRelatie_id |
guid |
Factuurrelatie-ID |
☐ |
De publieke sleutel (public identifier, als <a href="https://docs.microsoft.com/en-us/dotnet/api/System.Guid?view=netframework-4.6.2" target="_blank">System.Guid</a>) dat uniek een object identificeert. |
fileName |
string |
Bestandsnaam |
☐ |
Geeft de filename terug |
iban |
string(50) |
IBAN |
☐ |
Het IBAN-rekeningnummer van de relatie. |
id_1 |
guid |
ID |
☐ |
|
id |
guid |
ID |
☐ |
De publieke sleutel (public identifier, als <a href="https://docs.microsoft.com/en-us/dotnet/api/System.Guid?view=netframework-4.6.2" target="_blank">System.Guid</a>) dat uniek een object identificeert. |
incassoSoort |
string |
Incassosoort |
☐ |
Het soort incasso ({SnelStart.B2B.Api.V2.Models.Relaties.IncassosoortModel}) dat van toepassing is op de relatie (optioneel). |
inkoopBoekingenUri |
string |
Inkoopdagboek URI |
☐ |
Verwijzing naar de inkoopboekingen voor de relatie |
kredietLimiet |
double |
Kredietlimiet |
☐ |
Het standaard kredietlimiet (in €) van aan deze relatie wordt gegeven (optioneel). |
krediettermijn |
int32 |
Krediettermijn |
☐ |
Het standaard aantal dagen krediettermijn van aan deze relatie wordt gegeven (optioneel). |
kvkNummer |
string(12) |
Kamer van Koophandel-nummer |
☐ |
Het nummer van de Kamer van Koophandel van de relatie. |
memo |
string |
Memo |
☐ |
Een optioneel tekstveld voor aanvullende informatie. |
mobieleTelefoon |
string |
Mobiele Telefoon |
☐ |
Het mobiele nummer van de relatie. |
modifiedOn |
datetime |
Gewijzigd op |
☐ |
Datum waarop de gegevens van deze relatie zijn aangepast |
naam |
string(50) |
Naam |
☐ |
De volledige naam van de relatie. |
nonactief |
boolean |
Inactief |
☐ |
Een vlag dat aangeeft of een relatie niet meer actief is binnen de administratie.Indien <see langword="true" />, dan kan de relatie als "verwijderd" worden beschouwd. |
offerteAanvraagEmailVersturen_ccEmail |
string |
Offerteaanvraag CC E-mail |
☐ |
Het (optionele) email adres waarnaar email moeten worden ge-Cc-eed. |
offerteAanvraagEmailVersturen_email |
string |
Offerteaanvraag E-mail |
☐ |
Het email adres waarnaar email moeten worden verstuurd. |
offerteAanvraagEmailVersturen_shouldSend |
boolean |
Offerteaanvragen E-mail Versturen |
☐ |
Geeft aan (lezen/schrijven) of er email moet worden verstuurd. |
offerteEmailVersturen_ccEmail |
string |
Offerte CC E-mail |
☐ |
Het (optionele) email adres waarnaar email moeten worden ge-Cc-eed. |
offerteEmailVersturen_email |
string |
Offerte E-mail |
☐ |
Het email adres waarnaar email moeten worden verstuurd. |
offerteEmailVersturen_shouldSend |
boolean |
Offerte E-mail Sturen |
☐ |
Geeft aan (lezen/schrijven) of er email moet worden verstuurd. |
oin |
string(20) |
OIN |
☐ |
Organisatie-identificatienummer then behoeve van het identificeren van overheidsorganisaties |
parentIdentifier |
guid |
Ouder Identificatiecode |
☐ |
De public identifier van de gekoppelde parent. |
readOnly |
boolean |
Alleen-lezen |
☐ |
Document is alleen lezen |
relatiecode |
int32 |
Relatiecode |
☐ |
Het relatienummer |
telefoon |
string |
Telefoon |
☐ |
Het telefoonnummer van de relatie. |
ublBestandAlsBijlage |
boolean |
UBL-bestand als Bijlage |
☐ |
Een vlag dat aangeeft of een UBL-bestand als bijlage bij een email moet worden toegevoegd bij het versturen van facturen. |
verkoopBoekingenUri |
string |
Verkoopboekingen URI |
☐ |
Verwijzing naar de verkoopboekingen voor de relatie |
vestigingsAdres_contactpersoon |
string |
Bezoekadres Contactpersoon |
☐ |
De volledige naam van de contactpersoon op dit adres. |
vestigingsAdres_plaats |
string |
Bezoekadres Stad |
☐ |
De plaatsnaam van het adres. |
vestigingsAdres_postcode |
string |
Bezoekadres Postcode |
☐ |
De postcode van het adres. |
vestigingsAdres_straat |
string |
Bezoekadres Straat |
☐ |
De straatnaam (inclusief huisnummer). |
websiteUrl |
string(100) |
Website (URL) |
☐ |
De URL van de website van de relatie. |
10-02-2023 22:31 Versie 22.1.122-BETA+3761