Delen via


Vierkante betalingen (onafhankelijke uitgever) (preview)

Square helpt miljoenen verkopers hun bedrijf te runnen- van veilige creditcardverwerking tot oplossingen voor verkooppunten. Deze connector bevat acties voor de volgende eindpunten: Betalingen, Terminal, Orders, Abonnementen, Facturen, Catalogus, Inventaris en Klanten.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Troy Taylor
URL https://www.hitachisolutions.com
E-mailen ttaylor@hitachisolutions.com
Connector-metagegevens
Uitgever Troy Taylor
Webpagina https://squareup.com/
Privacybeleid https://squareup.com/us/en/legal/general/privacy
Categorieën Handel; Verkoop en CRM

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Abonnement bijwerken

Hiermee werkt u een abonnement bij. U kunt de waarden voor het abonnementsveld instellen, wijzigen en wissen.

Abonnement hervatten

Hiermee wordt een gedeactiveerd abonnement hervat.

Abonnement maken

Hiermee maakt u een abonnement voor een klant voor een abonnement. Als u een kaart opgeeft in het bestand in de aanvraag, wordt de kaart door Square in rekening gebracht voor het abonnement. Anders factureert Square een factuur aan het e-mailadres van de klant. Het abonnement wordt onmiddellijk gestart, tenzij de aanvraag de optionele start_date bevat. Elk afzonderlijk abonnement is gekoppeld aan een bepaalde locatie.

Abonnement ophalen

Hiermee haalt u een abonnement op.

Abonnement opzeggen

Hiermee stelt u het canceled_date veld in op het einde van de actieve factureringsperiode. Na deze datum verandert de status van ACTIEF in GEANNULEERD.

Abonnement zoeken

Zoekt naar abonnementen. Resultaten worden chronologisch gesorteerd op de aanmaakdatum van het abonnement. Als de aanvraag meer dan één locatie-id opgeeft, wordt het resultaat door het eindpunt gesorteerd op locatie-id en vervolgens op de aanmaakdatum binnen elke locatie. Als er geen locaties worden opgegeven in de query, worden alle locaties doorzocht.

Abonnementsevenementen vermelden

Een lijst met alle gebeurtenissen voor een specifiek abonnement.

Batch-catalogusobjecten ophalen

Retourneert een set objecten op basis van de opgegeven id. Elke CatalogItem die in de set wordt geretourneerd, bevat alle onderliggende gegevens, waaronder: alle CatalogItemVariation-objecten, verwijzingen naar de bijbehorende CatalogModifierList-objecten en de id's van alle CatalogTax-objecten die hierop van toepassing zijn.

Batch haalt voorraadaantallen op

Retourneert huidige aantallen voor de opgegeven CatalogObjects op de aangevraagde locaties.

Batch-orders ophalen

Haalt een set orders op met hun id's. Als er geen bepaalde order-id bestaat, wordt de id genegeerd in plaats van een fout te genereren.

Batch upsert-catalogusobjecten

Hiermee worden maximaal 10.000 doelobjecten gemaakt of bijgewerkt op basis van de opgegeven lijst met objecten. De doelobjecten worden gegroepeerd in batches en elke batch wordt op een alles-of-niets-manier ingevoegd/bijgewerkt. Als een object in een batch op een of andere manier onjuist is ingedeeld of een databasebeperking schendt, wordt de hele batch met dat item genegeerd. Andere batches in dezelfde aanvraag kunnen echter nog steeds slagen. Elke batch kan maximaal 1000 objecten bevatten en batches worden verwerkt, zolang het totale aantal objecten voor de aanvraag (items, variaties, wijzigingslijsten, kortingen en belastingen) niet meer dan 10.000 is.

Batchwijzigingsinventaris

Hiermee past u aanpassingen en aantallen toe op de opgegeven itemhoeveelheden. Bij succes: retourneert de huidige berekende aantallen voor alle objecten waarnaar in de aanvraag wordt verwezen.

Betaling annuleren

Annuleert (ongeldig) een betaling. U kunt dit eindpunt gebruiken om een betaling met de GOEDGEKEURDE status te annuleren.

Betaling annuleren met idempotentiesleutel

Annuleert (ongeldig) een betaling die is geïdentificeerd door de idempotentiesleutel die is opgegeven in de aanvraag. Gebruik deze methode wanneer de status van een CreatePayment-aanvraag onbekend is (bijvoorbeeld nadat u een CreatePayment-aanvraag hebt verzonden, treedt er een netwerkfout op en krijgt u geen antwoord). In dit geval kunt u Square omsturen om de betaling te annuleren met behulp van dit eindpunt. In de aanvraag geeft u dezelfde idempotentiesleutel op die u hebt opgegeven in uw CreatePayment-aanvraag die u wilt annuleren. Nadat u de betaling hebt geannuleerd, kunt u uw CreatePayment-aanvraag opnieuw indienen. Als er geen betaling met de opgegeven idempotentiesleutel wordt gevonden, wordt er geen actie ondernomen en wordt het eindpunt geretourneerd.

Betaling bijwerken

Hiermee wordt een betaling bijgewerkt met de status GOEDGEKEURD. U kunt de amount_money en tip_money bijwerken met behulp van dit eindpunt.

Betaling maken

Hiermee maakt u een betaling met behulp van de opgegeven bron. U kunt dit eindpunt gebruiken om een kaart (creditcard/debitcard of vierkante cadeaukaart) in rekening te brengen of een betaling vast te leggen die de verkoper buiten Square heeft ontvangen (contante betaling van een koper of een betaling die een externe entiteit namens de verkoper heeft verwerkt).

Betaling ophalen

Hiermee worden gegevens opgehaald voor een specifieke betaling.

Betaling voltooien

Hiermee wordt een betaling voltooid (vastgelegd). Standaard worden betalingen zo ingesteld dat ze onmiddellijk worden voltooid nadat ze zijn gemaakt.

Betalingen vermelden

Haalt een lijst met betalingen op die door de rekening die de aanvraag indient. Resultaten zijn uiteindelijk consistent en nieuwe betalingen of wijzigingen in betalingen kunnen enkele seconden duren.

Betalingsorder (bèta)

Betaal voor een bestelling met behulp van een of meer goedgekeurde betalingen of vereffen een bestelling met in totaal 0. Het totaal van de payment_ids die in de aanvraag wordt vermeld, moet gelijk zijn aan het ordertotaal. Orders met een totaal bedrag van 0 kunnen worden gemarkeerd als betaald door een lege matrix van payment_ids in de aanvraag op te geven.

Betalingsrestitutie aanvragen

Hiermee wordt een specifieke restitutie opgehaald met behulp van de refund_id.

Betalingsrestituties vermelden

Hiermee wordt een lijst met restituties opgehaald voor het account dat de aanvraag indient. Resultaten zijn uiteindelijk consistent en nieuwe restituties of wijzigingen in restituties kunnen enkele seconden duren.

Bewijs indienen

Dient bewijs in bij de bank van de kaarthouder. Voordat het bewijs wordt ingediend, verzamelt Square alle beschikbare bewijzen. Dit omvat bewijs dat is geüpload met behulp van createDisputeEvidenceFile en CreateDisputeEvidenceText-eindpunten en bewijs dat automatisch wordt geleverd door Square, indien beschikbaar.

Bewijs van geschil vermelden

Retourneert een lijst met bewijsmateriaal dat is gekoppeld aan een geschil.

Catalogusgegevens

Haalt informatie op over de Square Catalog-API, zoals limieten voor batchgrootten die kunnen worden gebruikt door het eindpunt BatchUpsertCatalogObjects.

Catalogusobject ophalen

Retourneert één CatalogItem als een CatalogObject op basis van de opgegeven id. Het geretourneerde object bevat alle relevante CatalogItem-informatie, waaronder: CatalogItemVariation-onderliggende items, verwijzingen naar de objecten CatalogModifierList en de id's van alle CatalogTax-objecten die hierop van toepassing zijn.

Catalogusobject verwijderen

Hiermee verwijdert u één CatalogObject op basis van de opgegeven id en retourneert u de set verwijderde id's in het antwoord. Verwijderen is een trapsgewijze gebeurtenis, zodat alle onderliggende elementen van het doelobject ook worden verwijderd. Als u bijvoorbeeld een CatalogItem verwijdert, worden ook alle onderliggende items van CatalogItemVariation verwijderd.

Catalogusobjecten batchgewijs verwijderen

Hiermee verwijdert u een set CatalogItems op basis van de opgegeven lijst met doel-id's en retourneert u een set verwijderde id's in het antwoord.

Catalogusobjecten zoeken

Hiermee wordt gezocht naar CatalogObject van elk type door overeenkomende ondersteunde zoekkenmerkwaarden, met uitzondering van aangepaste kenmerkwaarden voor items of itemvariaties, op basis van een of meer van de opgegeven queryfilters.

Check-outs voor zoekterminals

Hiermee wordt een gefilterde lijst opgehaald met Terminal-uitcheckaanvragen die zijn gemaakt door het account dat de aanvraag indient.

Domein registreren voor Apple Pay

Hiermee activeert u een domein voor gebruik met Apple Pay op het web en square. Er wordt een validatie uitgevoerd op dit domein door Apple om ervoor te zorgen dat het domein correct is ingesteld als een domein met Apple Pay.

Facturen weergeven

Retourneert een lijst met facturen voor een bepaalde locatie.

Facturen zoeken

Zoekt naar facturen vanaf een locatie die is opgegeven in het filter.

Factuur annuleren

Annuleert een factuur. De verkoper kan geen betalingen voor de geannuleerde factuur verzamelen.

Factuur bijwerken

Hiermee werkt u een factuur bij door velden te wijzigen, velden te wissen of beide.

Factuur maken

Hiermee maakt u een conceptfactuur voor een order die is gemaakt met behulp van de Orders-API. Er blijft een conceptfactuur in uw account en er wordt geen actie ondernomen. U moet de factuur publiceren voordat Square deze kan verwerken (stuur deze naar het e-mailadres van de klant of laad de kaart van de klant in het bestand).

Factuur ophalen

Hiermee haalt u een factuur op factuur-id op.

Factuur publiceren

Hiermee publiceert u de opgegeven conceptfactuur. Nadat een factuur is gepubliceerd, wordt Square opvolgen op basis van de factuurconfiguratie. Square verzendt bijvoorbeeld de factuur naar het e-mailadres van de klant, brengt de kaart van de klant in rekening of doet niets. Square maakt de factuur ook beschikbaar op een door Square gehoste factuurpagina.

Factuur verwijderen

Hiermee verwijdert u de opgegeven factuur. Wanneer een factuur wordt verwijderd, wordt de bijbehorende orderstatus gewijzigd in GEANNULEERD. U kunt alleen een conceptfactuur verwijderen (u kunt een gepubliceerde factuur niet verwijderen, inclusief een factuur die is gepland voor verwerking).

Fysiek aantal inventaris ophalen

Retourneert het object InventoryPhysicalCount met de opgegeven physical_count_id.

Geschil accepteren

Accepteert het verlies van een geschil. Square retourneert het betwiste bedrag aan de kaarthouder en werkt de status van het geschil bij naar GEACCEPTEERD. Square debiteert het betwiste bedrag van het vierkante account van de verkoper. Als de Square-rekening onvoldoende geld heeft, debiteert Square de bijbehorende bankrekening.

Geschil ophalen

Retourneert details over een specifiek geschil.

Geschilbewijs ophalen

Retourneert de metagegevens van het bewijs dat is opgegeven door de bewijs-id in het pad van de aanvraag-URL. U moet een kopie onderhouden van het bewijs dat u uploadt als u er later naar wilt verwijzen. U kunt het bewijs niet downloaden nadat u het hebt geüpload.

Geschilbewijs verwijderen

Hiermee verwijdert u opgegeven bewijs uit een geschil.

Geschillen vermelden

Retourneert een lijst met geschillen die zijn gekoppeld aan een bepaald account.

Groep toevoegen aan klant

Voegt een groepslidmaatschap toe aan een klant. De klant wordt geïdentificeerd door de customer_id waarde en de klantgroep wordt geïdentificeerd door de group_id waarde.

Groep verwijderen van klant

Hiermee verwijdert u een groepslidmaatschap van een klant. De klant wordt geïdentificeerd door de customer_id waarde en de klantgroep wordt geïdentificeerd door de group_id waarde.

Inventarisaanpassing ophalen

Retourneert het object InventoryAdjustment met de opgegeven adjustment_id.

Inventarisoverdracht ophalen (bèta)

Retourneert het InventoryTransfer-object met de opgegeven transfer_id.

Inventariswijzigingen in Batch ophalen

Retourneert historische fysieke tellingen en aanpassingen op basis van de opgegeven filtercriteria.

Itembelastingen bijwerken

Hiermee worden de CatalogTax-objecten bijgewerkt die van toepassing zijn op de beoogde CatalogItem zonder dat u een upsert hoeft uit te voeren op het hele item.

Kaart maken

Hiermee voegt u een kaart toe aan een bestaande verkoper.

Kaart ophalen

Hiermee worden details opgehaald voor een specifieke kaart.

Kaart uitschakelen

Hiermee wordt de kaart uitgeschakeld, waardoor er geen verdere updates of kosten meer in rekening worden gebracht. Het uitschakelen van een al uitgeschakelde kaart is toegestaan, maar heeft geen effect.

Klant bijwerken

Hiermee werkt u een klantprofiel bij. Als u een kenmerk wilt wijzigen, geeft u de nieuwe waarde op. Als u een kenmerk wilt verwijderen, geeft u de waarde op als een lege tekenreeks of leeg object.

Klant maken

Hiermee maakt u een nieuwe klant voor een bedrijf.

Klant ophalen

Retourneert details voor één klant.

Klant verwijderen

Hiermee verwijdert u een klantprofiel uit een bedrijf. Met deze bewerking worden ook alle gekoppelde kaarten in het bestand ontkoppeld.

Klanten vermelden

Toont klantprofielen die zijn gekoppeld aan een Square-account. Onder normale bedrijfsomstandigheden worden nieuw gemaakte of bijgewerkte klantprofielen binnen 30 seconden beschikbaar voor de vermeldingsbewerking. Af en toe kan het doorgeven van de nieuwe of bijgewerkte profielen dichter bij één minuut of langer duren, met name tijdens netwerkincidenten en storingen.

Klanten zoeken

Hiermee doorzoekt u de klantprofielen die zijn gekoppeld aan een Vierkant-account met behulp van een ondersteund queryfilter. Als u SearchCustomers aanroept zonder een expliciet queryfilter, worden alle klantprofielen alfabetisch gesorteerd op basis van given_name en family_name geretourneerd.

Klantgroep bijwerken

Hiermee werkt u een klantgroep bij.

Klantgroep maken

Hiermee maakt u een nieuwe klantgroep voor een bedrijf.

Klantgroep ophalen

Hiermee haalt u een specifieke klantgroep op.

Klantgroep verwijderen

Hiermee verwijdert u een klantgroep zoals aangegeven door de group_id waarde.

Klantgroepen weergeven

Haalt de lijst met klantgroepen van een bedrijf op.

Klantsegment ophalen

Hiermee haalt u een specifiek klantsegment op.

Klantsegmenten vermelden

Haalt de lijst met klantsegmenten van een bedrijf op.

Lijstcatalogus

Retourneert een lijst met CatalogObjects met alle objecten van een set gewenste typen (bijvoorbeeld alle CatalogItem- en CatalogTax-objecten) in de catalogus. ListCatalog retourneert geen verwijderde catalogusitems.

Lijstkaarten

Hiermee haalt u een lijst op met kaarten die eigendom zijn van het account dat de aanvraag indient.

Order berekenen (bèta)

Hiermee kunnen toepassingen preview-prijzen voor bestellingen bekijken zonder een order te maken.

Order maken

Hiermee maakt u een nieuwe bestelling die informatie kan bevatten over producten voor aankoop en instellingen die van toepassing zijn op de aankoop.

Order ophalen

Hiermee haalt u een order op id op.

Restitutiebetaling

Terugbetaling van een betaling. U kunt het volledige betalingsbedrag of een deel ervan terugbetalen. U kunt dit eindpunt gebruiken om een creditcardbetaling te terugbetalen of een restitutie van een contante of externe betaling vast te leggen.

Tekst voor geschilbewijs maken

Hiermee uploadt u tekst die moet worden gebruikt als bewijs voor een geschilvraag.

Terminal uitchecken annuleren

Hiermee annuleert u een Terminal-betalingsaanvraag als de status van de aanvraag dit toestaat.

Terminal uitchecken maken

Hiermee maakt u een Terminal-betaalaanvraag en verzendt u deze naar het opgegeven apparaat om een betaling voor het aangevraagde bedrag te doen.

Terminal uitchecken ophalen

Hiermee haalt u een Terminal-betaalaanvraag op door checkout_id.

Terminalrestitutie aanvragen

Hiermee wordt een Interac Terminal-restitutieobject opgehaald op basis van id.

Terminalrestitutie annuleren

Hiermee annuleert u een Interac Terminal-restitutieaanvraag op restitutieaanvraag-id als de status van de aanvraag dit toestaat.

Terminalrestitutie maken

Hiermee maakt u een aanvraag voor het terugbetalen van een Interac-betaling die is voltooid op een Square Terminal.

Terminalrestituties zoeken

Hiermee haalt u een gefilterde lijst met aanvragen voor terugbetaling van Interac Terminal op die zijn gemaakt door de verkoper die de aanvraag indient.

Upsert-catalogusobject

Hiermee maakt of werkt u het doelObject CatalogObject bij.

Volgorde bijwerken (bèta)

Hiermee wordt een geopende volgorde bijgewerkt door velden toe te voegen, te vervangen of te verwijderen. Orders met de status VOLTOOID of GEANNULEERD kunnen niet worden bijgewerkt.

Volgorde klonen (bèta)

Hiermee maakt u een nieuwe volgorde in de status CONCEPT door een bestaande order te dupliceren. De zojuist gemaakte order heeft alleen de kernvelden (zoals regelitems, belastingen en kortingen) die uit de oorspronkelijke order zijn gekopieerd.

Voorraadaantal ophalen

Hiermee wordt het huidige berekende aantal aandelen opgehaald voor een bepaald CatalogObject op een bepaalde set locaties.

Wijzigingslijsten voor items bijwerken

Hiermee werkt u de CatalogModifierList-objecten bij die van toepassing zijn op de beoogde CatalogItem zonder dat u een upsert hoeft uit te voeren op het hele item.

Zoekorders

Doorzoek alle orders naar een of meer locaties. Orders omvatten alle verkoop-, retour- en uitwisselingen, ongeacht hoe of wanneer ze het Square-ecosysteem hebben ingevoerd (zoals Point of Sale, Invoices en Connect-API's).

Abonnement bijwerken

Hiermee werkt u een abonnement bij. U kunt de waarden voor het abonnementsveld instellen, wijzigen en wissen.

Parameters

Name Sleutel Vereist Type Description
Abonnements-id
subscription_id True string

De id van het abonnement.

Versie
version integer

De huidige versie van dit object.

Belastingpercentage
tax_percentage string

Het belastingbedrag dat wordt toegepast bij het factureren van het abonnement.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Retouren

Name Pad Type Description
ID-kaart
subscription.id string

De unieke, door square uitgegeven id.

Locatie-id
subscription.location_id string

De id van de locatie.

Plan-id
subscription.plan_id string

De id van het gekoppelde abonnement.

Klant-id
subscription.customer_id string

De id van dit object die de klant vertegenwoordigt.

Toestand
subscription.status string

De huidige verificatiestatus van dit object.

Aantal
subscription.price_override_money.amount integer

Het bedrag.

Valuta
subscription.price_override_money.currency string

De valuta.

Versie
subscription.version integer

De huidige versie van dit object.

Gemaakt op
subscription.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Timezone
subscription.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Naam
subscription.source.name string

De naam.

Abonnement hervatten

Hiermee wordt een gedeactiveerd abonnement hervat.

Parameters

Name Sleutel Vereist Type Description
Abonnements-id
subscription_id True string

De id van het abonnement.

Retouren

Name Pad Type Description
ID-kaart
subscription.id string

De unieke, door square uitgegeven id.

Locatie-id
subscription.location_id string

De id van de locatie.

Plan-id
subscription.plan_id string

De id van het gekoppelde abonnement.

Klant-id
subscription.customer_id string

De id van dit object die de klant vertegenwoordigt.

Toestand
subscription.status string

De huidige verificatiestatus van dit object.

Aantal
subscription.price_override_money.amount integer

Het bedrag.

Valuta
subscription.price_override_money.currency string

De valuta.

Versie
subscription.version integer

De huidige versie van dit object.

Gemaakt op
subscription.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Timezone
subscription.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Naam
subscription.source.name string

De naam.

Abonnement maken

Hiermee maakt u een abonnement voor een klant voor een abonnement. Als u een kaart opgeeft in het bestand in de aanvraag, wordt de kaart door Square in rekening gebracht voor het abonnement. Anders factureert Square een factuur aan het e-mailadres van de klant. Het abonnement wordt onmiddellijk gestart, tenzij de aanvraag de optionele start_date bevat. Elk afzonderlijk abonnement is gekoppeld aan een bepaalde locatie.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Locatie-id
location_id string

De locatie-id.

Plan-id
plan_id string

De id van het abonnement dat is gemaakt met behulp van de Catalogus-API.

Klant-id
customer_id string

De id van de klant die moet worden gekoppeld.

Kaart-id
card_id string

De id van de klantkaart die moet worden in rekening gebracht.

Begindatum
start_date string

De begindatum van het abonnement, in JJJJ-MM-DD-indeling.

Belastingpercentage
tax_percentage string

De belasting die moet worden toegevoegd bij het factureren van het abonnement.

Aantal
amount integer

Het bedrag dat moet worden geaccepteerd voor deze betaling, niet inclusief tip_money.

Valuta
currency string

De ISO 4217-valutacode van 3 tekens.

Timezone
timezone string

De tijdzone die wordt gebruikt in datumberekeningen voor het abonnement.

Naam
name string

De naam van het object.

Retouren

Name Pad Type Description
ID-kaart
subscription.id string

De unieke, door square uitgegeven id.

Locatie-id
subscription.location_id string

De id van de locatie.

Plan-id
subscription.plan_id string

De id van het gekoppelde abonnement.

Klant-id
subscription.customer_id string

De id van dit object die de klant vertegenwoordigt.

Begindatum
subscription.start_date string

De begindatum van het abonnement, in JJJJ-MM-DD-indeling.

Toestand
subscription.status string

De huidige verificatiestatus van dit object.

Belastingpercentage
subscription.tax_percentage string

Het belastingbedrag dat wordt toegepast bij het factureren van het abonnement.

Aantal
subscription.price_override_money.amount integer

Het bedrag.

Valuta
subscription.price_override_money.currency string

De valuta.

Versie
subscription.version integer

De huidige versie van dit object.

Gemaakt op
subscription.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Kaart-id
subscription.card_id string

De id van de klantkaart die in rekening wordt gebracht voor het abonnement.

Timezone
subscription.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Naam
subscription.source.name string

De naam.

Abonnement ophalen

Hiermee haalt u een abonnement op.

Parameters

Name Sleutel Vereist Type Description
Abonnements-id
subscription_id True string

De id van het abonnement.

Retouren

Name Pad Type Description
ID-kaart
subscription.id string

De unieke, door square uitgegeven id.

Locatie-id
subscription.location_id string

De id van de locatie.

Plan-id
subscription.plan_id string

De id van het gekoppelde abonnement.

Klant-id
subscription.customer_id string

De id van dit object die de klant vertegenwoordigt.

Begindatum
subscription.start_date string

De begindatum van het abonnement, in JJJJ-MM-DD-indeling.

In rekening gebracht op datum
subscription.charged_through_date string

De datum waarop de klant wordt gefactureerd voor het abonnement, in JJJJ-MM-DD-indeling.

Toestand
subscription.status string

De huidige verificatiestatus van dit object.

Factuur-id's
subscription.invoice_ids array of string
Aantal
subscription.price_override_money.amount integer

Het bedrag.

Valuta
subscription.price_override_money.currency string

De valuta.

Gemaakt op
subscription.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Betaald tot datum
subscription.paid_until_date string

De datum die is betaald tot.

Timezone
subscription.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Naam
subscription.source.name string

De naam.

Abonnement opzeggen

Hiermee stelt u het canceled_date veld in op het einde van de actieve factureringsperiode. Na deze datum verandert de status van ACTIEF in GEANNULEERD.

Parameters

Name Sleutel Vereist Type Description
Abonnements-id
subscription_id True string

De id van het abonnement.

Retouren

Name Pad Type Description
ID-kaart
subscription.id string

De unieke, door square uitgegeven id.

Locatie-id
subscription.location_id string

De id van de locatie.

Plan-id
subscription.plan_id string

De id van het gekoppelde abonnement.

Klant-id
subscription.customer_id string

De id van dit object die de klant vertegenwoordigt.

Kaart-id
subscription.card_id string

De id van de klantkaart die in rekening wordt gebracht voor het abonnement.

Begindatum
subscription.start_date string

De begindatum van het abonnement, in JJJJ-MM-DD-indeling.

Geannuleerde datum
subscription.canceled_date string

De annuleringsdatum van het abonnement, in JJJJ-MM-DD-indeling.

Betaald tot datum
subscription.paid_until_date string

De datum die is betaald tot.

Toestand
subscription.status string

De huidige verificatiestatus van dit object.

Gemaakt op
subscription.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Versie
subscription.version integer

De huidige versie van dit object.

Timezone
subscription.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Naam
subscription.source.name string

De naam.

Abonnement zoeken

Zoekt naar abonnementen. Resultaten worden chronologisch gesorteerd op de aanmaakdatum van het abonnement. Als de aanvraag meer dan één locatie-id opgeeft, wordt het resultaat door het eindpunt gesorteerd op locatie-id en vervolgens op de aanmaakdatum binnen elke locatie. Als er geen locaties worden opgegeven in de query, worden alle locaties doorzocht.

Parameters

Name Sleutel Vereist Type Description
Locatie-id's
location_ids array of string
Klant-id's
customer_ids array of string
Bronnamen
source_names array of string

Retouren

Name Pad Type Description
Abonnementen
subscriptions array of object
ID-kaart
subscriptions.id string

De unieke, door square uitgegeven id.

Locatie-id
subscriptions.location_id string

De id voor de locatie.

Plan-id
subscriptions.plan_id string

De id van het gekoppelde abonnement

Klant-id
subscriptions.customer_id string

De door het vierkant toegewezen id van de klant die is gekoppeld aan het account.

Begindatum
subscriptions.start_date string

De begindatum van het abonnement, in JJJJ-MM-DD-indeling.

Geannuleerde datum
subscriptions.canceled_date string

De annuleringsdatum van het abonnement, in JJJJ-MM-DD-indeling.

In rekening gebracht op datum
subscriptions.charged_through_date string

De datum waarop de klant wordt gefactureerd voor het abonnement, in JJJJ-MM-DD-indeling.

Toestand
subscriptions.status string

De huidige verificatiestatus van dit object.

Gemaakt op
subscriptions.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Kaart-id
subscriptions.card_id string

De id van de klantkaart die in rekening wordt gebracht voor het abonnement.

Betaald tot datum
subscriptions.paid_until_date string

De datum die is betaald tot.

Timezone
subscriptions.timezone string

De tijdzone die wordt gebruikt om kalenderdatums op de factuur te interpreteren, zoals due_date. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Naam
subscriptions.source.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Belastingpercentage
subscriptions.tax_percentage string

Het belastingbedrag dat wordt toegepast bij het factureren van het abonnement.

Aantal
subscriptions.price_override_money.amount integer

Het bedrag.

Valuta
subscriptions.price_override_money.currency string

De valuta.

Versie
subscriptions.version integer

De huidige versie van het object.

Factuur-id's
subscriptions.invoice_ids array of string

Abonnementsevenementen vermelden

Een lijst met alle gebeurtenissen voor een specifiek abonnement.

Parameters

Name Sleutel Vereist Type Description
Abonnements-id
subscription_id True string

De id van het abonnement.

Retouren

Name Pad Type Description
Abonnementsevenementen
subscription_events array of object
ID-kaart
subscription_events.id string

De unieke, door square uitgegeven id.

Gebeurtenistype abonnement
subscription_events.subscription_event_type string

Type abonnementsevenement.

Ingangsdatum
subscription_events.effective_date string

De datum, in JJJJ-MM-DD-indeling, toen de abonnementsgebeurtenis van kracht werd.

Plan-id
subscription_events.plan_id string

De id van het gekoppelde abonnement

Batch-catalogusobjecten ophalen

Retourneert een set objecten op basis van de opgegeven id. Elke CatalogItem die in de set wordt geretourneerd, bevat alle onderliggende gegevens, waaronder: alle CatalogItemVariation-objecten, verwijzingen naar de bijbehorende CatalogModifierList-objecten en de id's van alle CatalogTax-objecten die hierop van toepassing zijn.

Parameters

Name Sleutel Vereist Type Description
Object-id's
object_ids array of string
Catalogusversie
catalog_version integer

De specifieke versie van de catalogusobjecten die in het antwoord moeten worden opgenomen. Hiermee kunt u historische versies van objecten ophalen. De opgegeven versiewaarde wordt vergeleken met het versiekenmerk van CatalogObjects.

Verwante objecten opnemen
include_related_objects boolean

Indien waar, bevat het antwoord aanvullende objecten die zijn gerelateerd aan de aangevraagde objecten, als volgt: Als het objectveld van het antwoord een CatalogItem bevat, worden de bijbehorende CatalogCategory-objecten, CatalogTax-objecten, CatalogImage-objecten en CatalogModifierLists geretourneerd in het related_objects veld van het antwoord. Als het objectveld van het antwoord een CatalogItemVariation bevat, wordt de bovenliggende CatalogItem geretourneerd in het related_objects veld van het antwoord.

Retouren

Name Pad Type Description
Objects
objects array of object
Typologie
objects.type string

Het type van dit object.

ID-kaart
objects.id string

De unieke, door square uitgegeven id.

Bijgewerkt op
objects.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
objects.version integer

De huidige versie van het object.

Wordt verwijderd
objects.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
objects.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
objects.item_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Description
objects.item_data.title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Categorie-ID
objects.item_data.category_id string

De id van de categorie van het item, indien van toepassing.

Belastingidentificatienummers
objects.item_data.tax_ids array of string
Variaties
objects.item_data.variations array of object
Typologie
objects.item_data.variations.type string

Het type van dit object. Elk objecttype heeft verwachte eigenschappen uitgedrukt in een gestructureerde indeling binnen het bijbehorende *_data veld hieronder.

ID-kaart
objects.item_data.variations.id string

Een id om naar dit object te verwijzen.

Bijgewerkt op
objects.item_data.variations.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
objects.item_data.variations.version integer

De versie van het object. Wanneer u een object bijwerkt, moet de opgegeven versie overeenkomen met de versie in de database, anders wordt de schrijfbewerking geweigerd als conflicterend.

Wordt verwijderd
objects.item_data.variations.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
objects.item_data.variations.present_at_all_locations boolean

Een lijst met locaties waar het object aanwezig is, zelfs als present_at_all_locations onwaar is. Dit kunnen locaties zijn die zijn gedeactiveerd.

Item-id
objects.item_data.variations.item_variation_data.item_id string

De id van het object met deze itemvariatie.

Naam
objects.item_data.variations.item_variation_data.name string

De naam van dit item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Rangtelwoord
objects.item_data.variations.item_variation_data.ordinal integer

De volgorde waarin deze itemvariatie moet worden weergegeven. Deze waarde is alleen-lezen.

Prijstype
objects.item_data.variations.item_variation_data.pricing_type string

Hiermee wordt aangegeven of de prijs van de artikelvariatie is vast of bepaald op het moment van verkoop.

Aantal
objects.item_data.variations.item_variation_data.price_money.amount integer

Het bedrag van het geld, in de kleinste benaming van de valuta aangegeven door valuta. Als valuta bijvoorbeeld USD is, is het bedrag in centen. Monetaire bedragen kunnen positief of negatief zijn. Zie de beschrijving van het specifieke veld om de betekenis van het teken in een bepaald geval te bepalen.

Valuta
objects.item_data.variations.item_variation_data.price_money.currency string

Het type valuta, in ISO 4217-indeling. De valutacode voor Amerikaanse dollars is bijvoorbeeld USD.

Verwante objecten
related_objects array of object
Typologie
related_objects.type string

Het type van dit object.

ID-kaart
related_objects.id string

De unieke, door square uitgegeven id.

Bijgewerkt op
related_objects.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
related_objects.version integer

De huidige versie van het object.

Wordt verwijderd
related_objects.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
related_objects.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
related_objects.category_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Naam
related_objects.tax_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Berekeningsfase
related_objects.tax_data.calculation_phase string

Of de belasting wordt berekend op basis van het subtotaal of het totaal van een betaling.

Insluitingstype
related_objects.tax_data.inclusion_type string

Of de belasting ADDITIEF of INCLUSIEF is.

Procent
related_objects.tax_data.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Ingeschakeld
related_objects.tax_data.enabled boolean

Hiermee wordt aangegeven of een object al dan niet kan worden gebruikt.

Batch haalt voorraadaantallen op

Retourneert huidige aantallen voor de opgegeven CatalogObjects op de aangevraagde locaties.

Parameters

Name Sleutel Vereist Type Description
Catalogusobject-id's
catalog_object_ids array of string
Locatie-id's
location_ids array of string
Bijgewerkt na
updated_after string

Het filter om resultaten te retourneren met hun calculated_at waarde na de opgegeven tijd zoals opgegeven in een RFC 3339-tijdstempel.

Retouren

Name Pad Type Description
Telt
counts array of object
Catalogusobject-id
counts.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobjecttype
counts.catalog_object_type string

Het type CatalogObject dat wordt bijgehouden.

Staat
counts.state string

De huidige status.

Locatie-id
counts.location_id string

De id voor de locatie.

Hoeveelheid
counts.quantity string

Het aantal items dat wordt beïnvloed door het geschatte aantal als een decimale tekenreeks. Kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Berekend op
counts.calculated_at string

Een RFC 3339-opgemaakt tijdstempel dat aangeeft wanneer het meest recente fysieke aantal of de meest recente aanpassing die van invloed is op het geschatte aantal wordt ontvangen.

Batch-orders ophalen

Haalt een set orders op met hun id's. Als er geen bepaalde order-id bestaat, wordt de id genegeerd in plaats van een fout te genereren.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id string

De locatie-id.

Order-id's
order_ids array of string

Retouren

Name Pad Type Description
Orders
orders array of object
ID-kaart
orders.id string

De unieke, door square uitgegeven id.

Locatie-id
orders.location_id string

De id voor de locatie.

Referentie-id
orders.reference_id string

Een optionele tweede id die wordt gebruikt om het klantprofiel te koppelen aan een entiteit in een ander systeem.

Regelitems
orders.line_items array of object
UID
orders.line_items.uid string

De door square gegenereerde id van de betalingsaanvraag in een factuur.

Naam
orders.line_items.name string

Een door mensen leesbare naam.

Hoeveelheid
orders.line_items.quantity string

De aangeschafte hoeveelheid, opgemaakt als een decimaal getal.

Aantal
orders.line_items.base_price_money.amount integer

Het bedrag.

Valuta
orders.line_items.base_price_money.currency string

De valuta.

Aantal
orders.line_items.total_money.amount integer

Het bedrag.

Valuta
orders.line_items.total_money.currency string

De valuta.

Aantal
orders.total_money.amount integer

Het bedrag.

Valuta
orders.total_money.currency string

De valuta.

Batch upsert-catalogusobjecten

Hiermee worden maximaal 10.000 doelobjecten gemaakt of bijgewerkt op basis van de opgegeven lijst met objecten. De doelobjecten worden gegroepeerd in batches en elke batch wordt op een alles-of-niets-manier ingevoegd/bijgewerkt. Als een object in een batch op een of andere manier onjuist is ingedeeld of een databasebeperking schendt, wordt de hele batch met dat item genegeerd. Andere batches in dezelfde aanvraag kunnen echter nog steeds slagen. Elke batch kan maximaal 1000 objecten bevatten en batches worden verwerkt, zolang het totale aantal objecten voor de aanvraag (items, variaties, wijzigingslijsten, kortingen en belastingen) niet meer dan 10.000 is.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Typologie
type string

Het type van dit object.

ID-kaart
id string

Een id om naar dit object te verwijzen.

Aanwezig op alle locaties
present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Description
title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Categorie-ID
category_id string

De id van de categorie van het item, indien van toepassing.

Belastingidentificatienummers
tax_ids array of string
Typologie
type string

Het type van dit object. Elk objecttype heeft verwachte eigenschappen uitgedrukt in een gestructureerde indeling binnen het bijbehorende *_data veld hieronder.

ID-kaart
id string

Een id om naar dit object te verwijzen.

Aanwezig op alle locaties
present_at_all_locations boolean

Of aanwezig is op alle locaties.

Item-id
item_id string

De id van het item.

Naam
name string

De naam van het item.

Prijstype
pricing_type string

Het type prijs.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Berekeningsfase
calculation_phase string

Of de belasting wordt berekend op basis van het subtotaal of het totaal van een betaling.

Insluitingstype
inclusion_type string

Of de belasting ADDITIEF of INCLUSIEF is.

Procent
percentage string

Het percentage van de belasting in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Van toepassing op aangepaste bedragen
applies_to_custom_amounts boolean

Indien waar, is de vergoeding van toepassing op aangepaste bedragen die zijn ingevoerd in de Square Point of Sale-app die niet zijn gekoppeld aan een bepaalde CatalogItem.

Ingeschakeld
enabled boolean

Een Booleaanse vlag om aan te geven of de belasting wordt weergegeven als ingeschakeld (true) in de Square Point of Sale-app of niet (onwaar).

Retouren

Name Pad Type Description
Objects
objects array of object
Typologie
objects.type string

Het type van dit object.

ID-kaart
objects.id string

De unieke, door square uitgegeven id.

Bijgewerkt op
objects.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
objects.version integer

De huidige versie van het object.

Wordt verwijderd
objects.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
objects.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
objects.item_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Description
objects.item_data.title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Categorie-ID
objects.item_data.category_id string

De id van de categorie van het item, indien van toepassing.

Belastingidentificatienummers
objects.item_data.tax_ids array of string
Variaties
objects.item_data.variations array of object
Typologie
objects.item_data.variations.type string

Het type van dit object. Elk objecttype heeft verwachte eigenschappen uitgedrukt in een gestructureerde indeling binnen het bijbehorende *_data veld hieronder.

ID-kaart
objects.item_data.variations.id string

Een id om naar dit object te verwijzen.

Bijgewerkt op
objects.item_data.variations.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
objects.item_data.variations.version integer

De versie van het object. Wanneer u een object bijwerkt, moet de opgegeven versie overeenkomen met de versie in de database, anders wordt de schrijfbewerking geweigerd als conflicterend.

Wordt verwijderd
objects.item_data.variations.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
objects.item_data.variations.present_at_all_locations boolean

Een lijst met locaties waar het object aanwezig is, zelfs als present_at_all_locations onwaar is. Dit kunnen locaties zijn die zijn gedeactiveerd.

Item-id
objects.item_data.variations.item_variation_data.item_id string

De id van het object met deze itemvariatie.

Naam
objects.item_data.variations.item_variation_data.name string

De naam van dit item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Rangtelwoord
objects.item_data.variations.item_variation_data.ordinal integer

De volgorde waarin deze itemvariatie moet worden weergegeven. Deze waarde is alleen-lezen.

Prijstype
objects.item_data.variations.item_variation_data.pricing_type string

Hiermee wordt aangegeven of de prijs van de artikelvariatie is vast of bepaald op het moment van verkoop.

Aantal
objects.item_data.variations.item_variation_data.price_money.amount integer

Het bedrag van het geld, in de kleinste benaming van de valuta aangegeven door valuta. Als valuta bijvoorbeeld USD is, is het bedrag in centen. Monetaire bedragen kunnen positief of negatief zijn. Zie de beschrijving van het specifieke veld om de betekenis van het teken in een bepaald geval te bepalen.

Valuta
objects.item_data.variations.item_variation_data.price_money.currency string

Het type valuta, in ISO 4217-indeling. De valutacode voor Amerikaanse dollars is bijvoorbeeld USD.

Naam
objects.category_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Naam
objects.tax_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Berekeningsfase
objects.tax_data.calculation_phase string

Of de belasting wordt berekend op basis van het subtotaal of het totaal van een betaling.

Insluitingstype
objects.tax_data.inclusion_type string

Of de belasting ADDITIEF of INCLUSIEF is.

Procent
objects.tax_data.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Van toepassing op aangepaste bedragen
objects.tax_data.applies_to_custom_amounts boolean

Indien waar, is de vergoeding van toepassing op aangepaste bedragen die zijn ingevoerd in de Square Point of Sale-app die niet zijn gekoppeld aan een bepaalde CatalogItem.

Ingeschakeld
objects.tax_data.enabled boolean

Hiermee wordt aangegeven of een object al dan niet kan worden gebruikt.

Id-toewijzingen
id_mappings array of object
Clientobject-id
id_mappings.client_object_id string

De door de client opgegeven tijdelijke #-voorvoegsel-id voor een nieuw CatalogObject.

Object-ID
id_mappings.object_id string

De permanente id die door de server is gemaakt.

Batchwijzigingsinventaris

Hiermee past u aanpassingen en aantallen toe op de opgegeven itemhoeveelheden. Bij succes: retourneert de huidige berekende aantallen voor alle objecten waarnaar in de aanvraag wordt verwezen.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Typologie
type string

Het type van dit object.

Referentie-id
reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id die deze kaart koppelt aan een andere entiteit in een extern systeem.

Catalogusobject-id
catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Staat
state string

De huidige voorraadstatus voor de gerelateerde hoeveelheid artikelen.

Locatie-id
location_id string

De locatie-id voor een ontvanger (anders dan de verkoper) die een deel van deze aanbesteding ontvangt.

Hoeveelheid
quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Werknemer-id
employee_id string

De door square gegenereerde id van de werknemer die verantwoordelijk is voor het fysieke aantal.

Opgetreden op
occurred_at string

Een door de client gegenereerde RFC 3339-geformatteerde tijdstempel die aangeeft wanneer het fysieke aantal is onderzocht. Voor updates voor fysieke aantallen mag de occurred_at tijdstempel niet ouder zijn dan 24 uur of in de toekomst ten opzichte van het tijdstip van de aanvraag.

Ongewijzigde aantallen negeren
ignore_unchanged_counts boolean

Geeft aan of het huidige fysieke aantal moet worden genegeerd als de hoeveelheid ongewijzigd is sinds het laatste fysieke aantal.

Retouren

Name Pad Type Description
Telt
counts array of object
Catalogusobject-id
counts.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobjecttype
counts.catalog_object_type string

Het type CatalogObject dat wordt bijgehouden.

Staat
counts.state string

De huidige status.

Locatie-id
counts.location_id string

De id voor de locatie.

Hoeveelheid
counts.quantity string

Het aantal items dat wordt beïnvloed door het geschatte aantal als een decimale tekenreeks. Kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Berekend op
counts.calculated_at string

Een RFC 3339-opgemaakt tijdstempel dat aangeeft wanneer het meest recente fysieke aantal of de meest recente aanpassing die van invloed is op het geschatte aantal wordt ontvangen.

Betaling annuleren

Annuleert (ongeldig) een betaling. U kunt dit eindpunt gebruiken om een betaling met de GOEDGEKEURDE status te annuleren.

Parameters

Name Sleutel Vereist Type Description
BetalingsID
payment_id True string

De id van de betaling.

Retouren

Name Pad Type Description
ID-kaart
payment.id string

De unieke, door square uitgegeven id.

Gemaakt op
payment.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
payment.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Aantal
payment.amount_money.amount integer

Het bedrag.

Valuta
payment.amount_money.currency string

De valuta.

Aantal
payment.tip_money.amount integer

Het bedrag.

Valuta
payment.tip_money.currency string

De valuta.

Toestand
payment.status string

De huidige verificatiestatus van dit object.

Vertragingsduur
payment.delay_duration string

De duur van de tijd na het maken van de betaling wanneer Square de delay_action automatisch toepast op de betaling. Deze automatische delay_action geldt alleen voor betalingen die vóór de delay_duration periode geen terminalstatus (VOLTOOID, GEANNULEERD of MISLUKT) bereiken. Dit veld wordt opgegeven als een tijdsduur, in RFC 3339-indeling.

Brontype
payment.source_type string

Het brontype voor deze betaling. Huidige waarden zijn CARD, BANK_ACCOUNT, WALLET, CASH of EXTERNAL.

Toestand
payment.card_details.status string

De huidige status.

Merk kaart
payment.card_details.card.card_brand string

Het merk van de kaart.

Laatste 4
payment.card_details.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
payment.card_details.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
payment.card_details.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
payment.card_details.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
payment.card_details.card.card_type string

Het type kaart.

Vooraf betaald type
payment.card_details.card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

VUILNISBAK
payment.card_details.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Invoermethode
payment.card_details.entry_method string

De methode die wordt gebruikt om de gegevens van de kaart voor de betaling in te voeren. De methode kan KEYED, SWIPED, EMV, ON_FILE of CONTACTLESS zijn.

CVV-status
payment.card_details.cvv_status string

De statuscode die wordt geretourneerd door de CVV-controle (Card Verification Value). De code kan worden CVV_ACCEPTED, CVV_REJECTED of CVV_NOT_CHECKED.

AVS-status
payment.card_details.avs_status string

De statuscode die wordt geretourneerd door de AVS-controle (Address Verification System). De code kan worden AVS_ACCEPTED, AVS_REJECTED of AVS_NOT_CHECKED.

Resultaatcode voor verificatie
payment.card_details.auth_result_code string

De statuscode die wordt geretourneerd door de kaartverlener die de autorisatiestatus van de betaling beschrijft.

Beschrijving van instructie
payment.card_details.statement_description string

De beschrijving van de instructie die naar de kaartnetwerken is verzonden.

Geautoriseerd op
payment.card_details.card_payment_timeline.authorized_at string

De tijdstempel waarop de betaling is geautoriseerd, in RFC 3339-indeling.

Ongeldig op
payment.card_details.card_payment_timeline.voided_at string

De tijdstempel waarop de betaling is geannuleerd, in RFC 3339-indeling.

Locatie-id
payment.location_id string

De id van de locatie.

Order-id
payment.order_id string

De id van de order.

Gemaakt op
payment.risk_evaluation.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Risiconiveau
payment.risk_evaluation.risk_level string

Het risiconiveau dat aan de betaling is gekoppeld.

Opmerking
payment.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Klant-id
payment.customer_id string

De id van dit object die de klant vertegenwoordigt.

Aantal
payment.total_money.amount integer

Het bedrag.

Valuta
payment.total_money.currency string

De valuta.

Aantal
payment.approved_money.amount integer

Het bedrag.

Valuta
payment.approved_money.currency string

De valuta.

Actie vertragen
payment.delay_action string

De actie die moet worden toegepast op de betaling wanneer de delay_duration is verstreken.

Vertraagd tot
payment.delayed_until string

De alleen-lezen tijdstempel van wanneer de delay_action automatisch wordt toegepast, in RFC 3339-indeling.

Vierkant product
payment.application_details.square_product string

Het Square-product, zoals Square Point of Sale (POS), Square Invoices of Square Virtual Terminal.

Applicatie-ID
payment.application_details.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Versietoken
payment.version_token string

Dit ondoorzichtige token identificeert een specifieke versie van het object.

Betaling annuleren met idempotentiesleutel

Annuleert (ongeldig) een betaling die is geïdentificeerd door de idempotentiesleutel die is opgegeven in de aanvraag. Gebruik deze methode wanneer de status van een CreatePayment-aanvraag onbekend is (bijvoorbeeld nadat u een CreatePayment-aanvraag hebt verzonden, treedt er een netwerkfout op en krijgt u geen antwoord). In dit geval kunt u Square omsturen om de betaling te annuleren met behulp van dit eindpunt. In de aanvraag geeft u dezelfde idempotentiesleutel op die u hebt opgegeven in uw CreatePayment-aanvraag die u wilt annuleren. Nadat u de betaling hebt geannuleerd, kunt u uw CreatePayment-aanvraag opnieuw indienen. Als er geen betaling met de opgegeven idempotentiesleutel wordt gevonden, wordt er geen actie ondernomen en wordt het eindpunt geretourneerd.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

response
object

Betaling bijwerken

Hiermee wordt een betaling bijgewerkt met de status GOEDGEKEURD. U kunt de amount_money en tip_money bijwerken met behulp van dit eindpunt.

Parameters

Name Sleutel Vereist Type Description
BetalingsID
payment_id True string

De id van de betaling.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Versietoken
version_token string

Dit ondoorzichtige token identificeert een specifieke versie van het object.

Retouren

Name Pad Type Description
ID-kaart
payment.id string

De unieke, door square uitgegeven id.

Gemaakt op
payment.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
payment.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Aantal
payment.amount_money.amount integer

Het bedrag.

Valuta
payment.amount_money.currency string

De valuta.

Aantal
payment.tip_money.amount integer

Het bedrag.

Valuta
payment.tip_money.currency string

De valuta.

Toestand
payment.status string

De huidige verificatiestatus van dit object.

Vertragingsduur
payment.delay_duration string

De duur van de tijd na het maken van de betaling wanneer Square de delay_action automatisch toepast op de betaling. Deze automatische delay_action geldt alleen voor betalingen die vóór de delay_duration periode geen terminalstatus (VOLTOOID, GEANNULEERD of MISLUKT) bereiken. Dit veld wordt opgegeven als een tijdsduur, in RFC 3339-indeling.

Brontype
payment.source_type string

Het brontype voor deze betaling. Huidige waarden zijn CARD, BANK_ACCOUNT, WALLET, CASH of EXTERNAL.

Toestand
payment.card_details.status string

De huidige status.

Merk kaart
payment.card_details.card.card_brand string

Het merk van de kaart.

Laatste 4
payment.card_details.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
payment.card_details.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
payment.card_details.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
payment.card_details.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
payment.card_details.card.card_type string

Het type kaart.

Vooraf betaald type
payment.card_details.card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

VUILNISBAK
payment.card_details.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Invoermethode
payment.card_details.entry_method string

De methode die wordt gebruikt om de gegevens van de kaart voor de betaling in te voeren. De methode kan KEYED, SWIPED, EMV, ON_FILE of CONTACTLESS zijn.

CVV-status
payment.card_details.cvv_status string

De statuscode die wordt geretourneerd door de CVV-controle (Card Verification Value). De code kan worden CVV_ACCEPTED, CVV_REJECTED of CVV_NOT_CHECKED.

AVS-status
payment.card_details.avs_status string

De statuscode die wordt geretourneerd door de AVS-controle (Address Verification System). De code kan worden AVS_ACCEPTED, AVS_REJECTED of AVS_NOT_CHECKED.

Resultaatcode voor verificatie
payment.card_details.auth_result_code string

De statuscode die wordt geretourneerd door de kaartverlener die de autorisatiestatus van de betaling beschrijft.

Beschrijving van instructie
payment.card_details.statement_description string

De beschrijving van de instructie die naar de kaartnetwerken is verzonden.

Geautoriseerd op
payment.card_details.card_payment_timeline.authorized_at string

De tijdstempel waarop de betaling is geautoriseerd, in RFC 3339-indeling.

Locatie-id
payment.location_id string

De id van de locatie.

Order-id
payment.order_id string

De id van de order.

Gemaakt op
payment.risk_evaluation.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Risiconiveau
payment.risk_evaluation.risk_level string

Het risiconiveau dat aan de betaling is gekoppeld.

Opmerking
payment.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Klant-id
payment.customer_id string

De id van dit object die de klant vertegenwoordigt.

Aantal
payment.total_money.amount integer

Het bedrag.

Valuta
payment.total_money.currency string

De valuta.

Aantal
payment.approved_money.amount integer

Het bedrag.

Valuta
payment.approved_money.currency string

De valuta.

Capabilities
payment.capabilities array of string
Ontvangstnummer
payment.receipt_number string

Het ontvangstbewijsnummer van de betaling. Het veld ontbreekt als een betaling wordt geannuleerd.

Actie vertragen
payment.delay_action string

De actie die moet worden toegepast op de betaling wanneer de delay_duration is verstreken.

Vertraagd tot
payment.delayed_until string

De alleen-lezen tijdstempel van wanneer de delay_action automatisch wordt toegepast, in RFC 3339-indeling.

Vierkant product
payment.application_details.square_product string

Het Square-product, zoals Square Point of Sale (POS), Square Invoices of Square Virtual Terminal.

Applicatie-ID
payment.application_details.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Versietoken
payment.version_token string

Dit ondoorzichtige token identificeert een specifieke versie van het object.

Betaling maken

Hiermee maakt u een betaling met behulp van de opgegeven bron. U kunt dit eindpunt gebruiken om een kaart (creditcard/debitcard of vierkante cadeaukaart) in rekening te brengen of een betaling vast te leggen die de verkoper buiten Square heeft ontvangen (contante betaling van een koper of een betaling die een externe entiteit namens de verkoper heeft verwerkt).

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Aantal
amount integer

Het bedrag dat moet worden geaccepteerd voor deze betaling, niet inclusief tip_money.

Valuta
currency string

De ISO 4217-valutacode van 3 tekens.

Bron-id
source_id string

De id voor de bron van fondsen voor deze betaling. Dit kan een betalingstoken (kaart nonce) zijn dat wordt gegenereerd door het vierkante betalingsformulier of een kaart in het bestand dat is gemaakt met de Klanten-API. Als u een betaling registreert die de verkoper buiten Square heeft ontvangen, geeft u CASH of EXTERNAL op.

Automatisch aanvullen
autocomplete boolean

Indien ingesteld op true, wordt deze betaling indien mogelijk voltooid. Indien ingesteld op onwaar, wordt deze betaling in een goedgekeurde staat bewaard totdat deze expliciet is voltooid (vastgelegd) of geannuleerd (ongeldig).

Klant-id
customer_id string

De id van de klant die moet worden gekoppeld.

Locatie-id
location_id string

De locatie-id.

Referentie-id
reference_id string

Een optionele tweede id die wordt gebruikt om het klantprofiel te koppelen aan een entiteit in een ander systeem.

Opmerking
note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Aantal
amount integer

Het bedrag dat moet worden geaccepteerd voor deze betaling, niet inclusief tip_money.

Valuta
currency string

De ISO 4217-valutacode van 3 tekens.

Retouren

Name Pad Type Description
ID-kaart
payment.id string

De unieke, door square uitgegeven id.

Gemaakt op
payment.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
payment.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Aantal
payment.amount_money.amount integer

Het bedrag.

Valuta
payment.amount_money.currency string

De valuta.

Aantal
payment.app_fee_money.amount integer

Het bedrag.

Valuta
payment.app_fee_money.currency string

De valuta.

Toestand
payment.status string

De huidige verificatiestatus van dit object.

Vertragingsduur
payment.delay_duration string

De duur van de tijd na het maken van de betaling wanneer Square de delay_action automatisch toepast op de betaling. Deze automatische delay_action geldt alleen voor betalingen die vóór de delay_duration periode geen terminalstatus (VOLTOOID, GEANNULEERD of MISLUKT) bereiken. Dit veld wordt opgegeven als een tijdsduur, in RFC 3339-indeling.

Brontype
payment.source_type string

Het brontype voor deze betaling. Huidige waarden zijn CARD, BANK_ACCOUNT, WALLET, CASH of EXTERNAL.

Toestand
payment.card_details.status string

De huidige status.

Merk kaart
payment.card_details.card.card_brand string

Het merk van de kaart.

Laatste 4
payment.card_details.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
payment.card_details.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
payment.card_details.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
payment.card_details.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
payment.card_details.card.card_type string

Het type kaart.

Vooraf betaald type
payment.card_details.card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

VUILNISBAK
payment.card_details.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Invoermethode
payment.card_details.entry_method string

De methode die wordt gebruikt om de gegevens van de kaart voor de betaling in te voeren. De methode kan KEYED, SWIPED, EMV, ON_FILE of CONTACTLESS zijn.

CVV-status
payment.card_details.cvv_status string

De statuscode die wordt geretourneerd door de CVV-controle (Card Verification Value). De code kan worden CVV_ACCEPTED, CVV_REJECTED of CVV_NOT_CHECKED.

AVS-status
payment.card_details.avs_status string

De statuscode die wordt geretourneerd door de AVS-controle (Address Verification System). De code kan worden AVS_ACCEPTED, AVS_REJECTED of AVS_NOT_CHECKED.

Resultaatcode voor verificatie
payment.card_details.auth_result_code string

De statuscode die wordt geretourneerd door de kaartverlener die de autorisatiestatus van de betaling beschrijft.

Beschrijving van instructie
payment.card_details.statement_description string

De beschrijving van de instructie die naar de kaartnetwerken is verzonden.

Geautoriseerd op
payment.card_details.card_payment_timeline.authorized_at string

De tijdstempel waarop de betaling is geautoriseerd, in RFC 3339-indeling.

Vastgelegd op
payment.card_details.card_payment_timeline.captured_at string

De tijdstempel waarop de betaling is vastgelegd, in RFC 3339-indeling.

Locatie-id
payment.location_id string

De id van de locatie.

Order-id
payment.order_id string

De id van de order.

Referentie-id
payment.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Gemaakt op
payment.risk_evaluation.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Risiconiveau
payment.risk_evaluation.risk_level string

Het risiconiveau dat aan de betaling is gekoppeld.

Opmerking
payment.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Klant-id
payment.customer_id string

De id van dit object die de klant vertegenwoordigt.

Aantal
payment.total_money.amount integer

Het bedrag.

Valuta
payment.total_money.currency string

De valuta.

Aantal
payment.approved_money.amount integer

Het bedrag.

Valuta
payment.approved_money.currency string

De valuta.

Ontvangstnummer
payment.receipt_number string

Het ontvangstbewijsnummer van de betaling. Het veld ontbreekt als een betaling wordt geannuleerd.

Ontvangst-URL
payment.receipt_url string

De URL voor het ontvangstbewijs van de betaling. Het veld is alleen ingevuld voor VOLTOOIDe betalingen.

Actie vertragen
payment.delay_action string

De actie die moet worden toegepast op de betaling wanneer de delay_duration is verstreken.

Vertraagd tot
payment.delayed_until string

De alleen-lezen tijdstempel van wanneer de delay_action automatisch wordt toegepast, in RFC 3339-indeling.

Vierkant product
payment.application_details.square_product string

Het Square-product, zoals Square Point of Sale (POS), Square Invoices of Square Virtual Terminal.

Applicatie-ID
payment.application_details.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Versietoken
payment.version_token string

Dit ondoorzichtige token identificeert een specifieke versie van het object.

Betaling ophalen

Hiermee worden gegevens opgehaald voor een specifieke betaling.

Parameters

Name Sleutel Vereist Type Description
BetalingsID
payment_id True string

De id van de betaling.

Retouren

Name Pad Type Description
ID-kaart
payment.id string

De unieke, door square uitgegeven id.

Gemaakt op
payment.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
payment.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Aantal
payment.amount_money.amount integer

Het bedrag.

Valuta
payment.amount_money.currency string

De valuta.

Toestand
payment.status string

De huidige verificatiestatus van dit object.

Vertragingsduur
payment.delay_duration string

De duur van de tijd na het maken van de betaling wanneer Square de delay_action automatisch toepast op de betaling. Deze automatische delay_action geldt alleen voor betalingen die vóór de delay_duration periode geen terminalstatus (VOLTOOID, GEANNULEERD of MISLUKT) bereiken. Dit veld wordt opgegeven als een tijdsduur, in RFC 3339-indeling.

Brontype
payment.source_type string

Het brontype voor deze betaling. Huidige waarden zijn CARD, BANK_ACCOUNT, WALLET, CASH of EXTERNAL.

Toestand
payment.card_details.status string

De huidige status.

Merk kaart
payment.card_details.card.card_brand string

Het merk van de kaart.

Laatste 4
payment.card_details.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
payment.card_details.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
payment.card_details.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
payment.card_details.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
payment.card_details.card.card_type string

Het type kaart.

Vooraf betaald type
payment.card_details.card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

VUILNISBAK
payment.card_details.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Invoermethode
payment.card_details.entry_method string

De methode die wordt gebruikt om de gegevens van de kaart voor de betaling in te voeren. De methode kan KEYED, SWIPED, EMV, ON_FILE of CONTACTLESS zijn.

CVV-status
payment.card_details.cvv_status string

De statuscode die wordt geretourneerd door de CVV-controle (Card Verification Value). De code kan worden CVV_ACCEPTED, CVV_REJECTED of CVV_NOT_CHECKED.

AVS-status
payment.card_details.avs_status string

De statuscode die wordt geretourneerd door de AVS-controle (Address Verification System). De code kan worden AVS_ACCEPTED, AVS_REJECTED of AVS_NOT_CHECKED.

Resultaatcode voor verificatie
payment.card_details.auth_result_code string

De statuscode die wordt geretourneerd door de kaartverlener die de autorisatiestatus van de betaling beschrijft.

Beschrijving van instructie
payment.card_details.statement_description string

De beschrijving van de instructie die naar de kaartnetwerken is verzonden.

Geautoriseerd op
payment.card_details.card_payment_timeline.authorized_at string

De tijdstempel waarop de betaling is geautoriseerd, in RFC 3339-indeling.

Vastgelegd op
payment.card_details.card_payment_timeline.captured_at string

De tijdstempel waarop de betaling is vastgelegd, in RFC 3339-indeling.

Locatie-id
payment.location_id string

De id van de locatie.

Order-id
payment.order_id string

De id van de order.

Verwerkingskosten
payment.processing_fee array of object
Effectief op
payment.processing_fee.effective_at string

De tijdstempel van wanneer de vergoeding van kracht wordt, in RFC 3339-indeling.

Typologie
payment.processing_fee.type string

Geeft het type aan.

Aantal
payment.processing_fee.amount_money.amount integer

Het bedrag.

Valuta
payment.processing_fee.amount_money.currency string

De valuta.

Opmerking
payment.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Aantal
payment.total_money.amount integer

Het bedrag.

Valuta
payment.total_money.currency string

De valuta.

Aantal
payment.approved_money.amount integer

Het bedrag.

Valuta
payment.approved_money.currency string

De valuta.

Werknemer-id
payment.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Ontvangstnummer
payment.receipt_number string

Het ontvangstbewijsnummer van de betaling. Het veld ontbreekt als een betaling wordt geannuleerd.

Ontvangst-URL
payment.receipt_url string

De URL voor het ontvangstbewijs van de betaling. Het veld is alleen ingevuld voor VOLTOOIDe betalingen.

Actie vertragen
payment.delay_action string

De actie die moet worden toegepast op de betaling wanneer de delay_duration is verstreken.

Vertraagd tot
payment.delayed_until string

De alleen-lezen tijdstempel van wanneer de delay_action automatisch wordt toegepast, in RFC 3339-indeling.

Teamlid-id
payment.team_member_id string

De id van het teamlid.

Vierkant product
payment.application_details.square_product string

Het Square-product, zoals Square Point of Sale (POS), Square Invoices of Square Virtual Terminal.

Applicatie-ID
payment.application_details.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Versietoken
payment.version_token string

Dit ondoorzichtige token identificeert een specifieke versie van het object.

Betaling voltooien

Hiermee wordt een betaling voltooid (vastgelegd). Standaard worden betalingen zo ingesteld dat ze onmiddellijk worden voltooid nadat ze zijn gemaakt.

Parameters

Name Sleutel Vereist Type Description
BetalingsID
payment_id True string

De id van de betaling.

Retouren

Name Pad Type Description
ID-kaart
payment.id string

De unieke, door square uitgegeven id.

Gemaakt op
payment.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
payment.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Aantal
payment.amount_money.amount integer

Het bedrag.

Valuta
payment.amount_money.currency string

De valuta.

Toestand
payment.status string

De huidige verificatiestatus van dit object.

Vertragingsduur
payment.delay_duration string

De duur van de tijd na het maken van de betaling wanneer Square de delay_action automatisch toepast op de betaling. Deze automatische delay_action geldt alleen voor betalingen die vóór de delay_duration periode geen terminalstatus (VOLTOOID, GEANNULEERD of MISLUKT) bereiken. Dit veld wordt opgegeven als een tijdsduur, in RFC 3339-indeling.

Brontype
payment.source_type string

Het brontype voor deze betaling. Huidige waarden zijn CARD, BANK_ACCOUNT, WALLET, CASH of EXTERNAL.

Toestand
payment.card_details.status string

De huidige status.

Merk kaart
payment.card_details.card.card_brand string

Het merk van de kaart.

Laatste 4
payment.card_details.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
payment.card_details.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
payment.card_details.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
payment.card_details.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
payment.card_details.card.card_type string

Het type kaart.

Vooraf betaald type
payment.card_details.card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

VUILNISBAK
payment.card_details.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Invoermethode
payment.card_details.entry_method string

De methode die wordt gebruikt om de gegevens van de kaart voor de betaling in te voeren. De methode kan KEYED, SWIPED, EMV, ON_FILE of CONTACTLESS zijn.

CVV-status
payment.card_details.cvv_status string

De statuscode die wordt geretourneerd door de CVV-controle (Card Verification Value). De code kan worden CVV_ACCEPTED, CVV_REJECTED of CVV_NOT_CHECKED.

AVS-status
payment.card_details.avs_status string

De statuscode die wordt geretourneerd door de AVS-controle (Address Verification System). De code kan worden AVS_ACCEPTED, AVS_REJECTED of AVS_NOT_CHECKED.

Resultaatcode voor verificatie
payment.card_details.auth_result_code string

De statuscode die wordt geretourneerd door de kaartverlener die de autorisatiestatus van de betaling beschrijft.

Beschrijving van instructie
payment.card_details.statement_description string

De beschrijving van de instructie die naar de kaartnetwerken is verzonden.

Geautoriseerd op
payment.card_details.card_payment_timeline.authorized_at string

De tijdstempel waarop de betaling is geautoriseerd, in RFC 3339-indeling.

Vastgelegd op
payment.card_details.card_payment_timeline.captured_at string

De tijdstempel waarop de betaling is vastgelegd, in RFC 3339-indeling.

Locatie-id
payment.location_id string

De id van de locatie.

Order-id
payment.order_id string

De id van de order.

Verwerkingskosten
payment.processing_fee array of object
Effectief op
payment.processing_fee.effective_at string

De tijdstempel van wanneer de vergoeding van kracht wordt, in RFC 3339-indeling.

Typologie
payment.processing_fee.type string

Geeft het type aan.

Aantal
payment.processing_fee.amount_money.amount integer

Het bedrag.

Valuta
payment.processing_fee.amount_money.currency string

De valuta.

Opmerking
payment.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Aantal
payment.total_money.amount integer

Het bedrag.

Valuta
payment.total_money.currency string

De valuta.

Aantal
payment.approved_money.amount integer

Het bedrag.

Valuta
payment.approved_money.currency string

De valuta.

Werknemer-id
payment.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Ontvangstnummer
payment.receipt_number string

Het ontvangstbewijsnummer van de betaling. Het veld ontbreekt als een betaling wordt geannuleerd.

Ontvangst-URL
payment.receipt_url string

De URL voor het ontvangstbewijs van de betaling. Het veld is alleen ingevuld voor VOLTOOIDe betalingen.

Actie vertragen
payment.delay_action string

De actie die moet worden toegepast op de betaling wanneer de delay_duration is verstreken.

Vertraagd tot
payment.delayed_until string

De alleen-lezen tijdstempel van wanneer de delay_action automatisch wordt toegepast, in RFC 3339-indeling.

Teamlid-id
payment.team_member_id string

De id van het teamlid.

Vierkant product
payment.application_details.square_product string

Het Square-product, zoals Square Point of Sale (POS), Square Invoices of Square Virtual Terminal.

Applicatie-ID
payment.application_details.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Versietoken
payment.version_token string

Dit ondoorzichtige token identificeert een specifieke versie van het object.

Betalingen vermelden

Haalt een lijst met betalingen op die door de rekening die de aanvraag indient. Resultaten zijn uiteindelijk consistent en nieuwe betalingen of wijzigingen in betalingen kunnen enkele seconden duren.

Parameters

Name Sleutel Vereist Type Description
Begintijd
begin_time string

De inclusieve begintijd van de query op opened_at, in ISO 8601-indeling.

Eindtijd
end_time string

De exclusieve einddatum van de query op opened_at, in ISO 8601-indeling.

Sorteervolgorde
sort_order string

Hiermee sorteert u de geretourneerde lijst op het moment dat de kaart is gemaakt met de opgegeven volgorde.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Total
total integer

Het exacte bedrag in de total_money voor een betaling.

Laatste 4
last_4 string

De laatste vier cijfers van een betaalkaart.

Merk kaart
card_brand string

Het merk van de betaalkaart (bijvoorbeeld VISA).

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Retouren

Name Pad Type Description
Payments
payments array of object
ID-kaart
payments.id string

De unieke, door square uitgegeven id.

Gemaakt op
payments.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
payments.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Aantal
payments.amount_money.amount integer

Het bedrag.

Valuta
payments.amount_money.currency string

De valuta.

Toestand
payments.status string

De huidige verificatiestatus van dit object.

Vertragingsduur
payments.delay_duration string

De duur van de tijd na het maken van de betaling wanneer Square de delay_action automatisch toepast op de betaling.

Brontype
payments.source_type string

Het brontype voor deze betaling.

Toestand
payments.card_details.status string

De huidige status van de kaartbetaling. De status kan WORDEN GEAUTORISEERD, VASTGELEGD, ONGELDIG OF MISLUKT.

Merk kaart
payments.card_details.card.card_brand string

Het merk van de kaart.

last_4
payments.card_details.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
payments.card_details.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
payments.card_details.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
payments.card_details.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
payments.card_details.card.card_type string

Het type kaart.

Vooraf betaald type
payments.card_details.card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

VUILNISBAK
payments.card_details.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN)

Invoermethode
payments.card_details.entry_method string

De methode die wordt gebruikt om de gegevens van de kaart voor de betaling in te voeren. De methode kan KEYED, SWIPED, EMV, ON_FILE of CONTACTLESS zijn.

Cvv-status
payments.card_details.cvv_status string

De statuscode die wordt geretourneerd door de CVV-controle (Card Verification Value). De code kan worden CVV_ACCEPTED, CVV_REJECTED of CVV_NOT_CHECKED.

Avs-status
payments.card_details.avs_status string

De statuscode die wordt geretourneerd door de AVS-controle (Address Verification System). De code kan worden AVS_ACCEPTED, AVS_REJECTED of AVS_NOT_CHECKED.

Resultaatcode voor verificatie
payments.card_details.auth_result_code string

De statuscode die wordt geretourneerd door de kaartverlener die de autorisatiestatus van de betaling beschrijft.

Beschrijving van instructie
payments.card_details.statement_description string

De beschrijving van de instructie die naar de kaartnetwerken is verzonden.

Geautoriseerd op
payments.card_details.card_payment_timeline.authorized_at string

De tijdstempel waarop de betaling is geautoriseerd, in RFC 3339-indeling.

Vastgelegd op
payments.card_details.card_payment_timeline.captured_at string

De tijdstempel waarop de betaling is vastgelegd, in RFC 3339-indeling.

Locatie-id
payments.location_id string

De id voor de locatie.

Order-id
payments.order_id string

De id van de order.

Verwerkingskosten
payments.processing_fee array of object
Effectief op
payments.processing_fee.effective_at string

De tijdstempel van wanneer de vergoeding van kracht wordt, in RFC 3339-indeling.

Typologie
payments.processing_fee.type string

Het type van dit object.

Aantal
payments.processing_fee.amount_money.amount integer

Het bedrag.

Valuta
payments.processing_fee.amount_money.currency string

De valuta.

Opmerking
payments.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Aantal
payments.total_money.amount integer

Het bedrag.

Valuta
payments.total_money.currency string

De valuta.

Aantal
payments.approved_money.amount integer

Het bedrag.

Valuta
payments.approved_money.currency string

De valuta.

Ontvangstnummer
payments.receipt_number string

Het ontvangstbewijsnummer van de betaling. Het veld ontbreekt als een betaling wordt geannuleerd.

Ontvangst-URL
payments.receipt_url string

De URL voor het ontvangstbewijs van de betaling. Het veld is alleen ingevuld voor VOLTOOIDe betalingen.

Actie vertragen
payments.delay_action string

De actie die moet worden toegepast op de betaling wanneer de delay_duration is verstreken.

Vertraagd tot
payments.delayed_until string

De alleen-lezen tijdstempel van wanneer de delay_action automatisch wordt toegepast, in RFC 3339-indeling.

Teamlid-id
payments.team_member_id string

De id van het TeamMember-object voor het teamlid dat aan het object is gekoppeld.

Vierkant product
payments.application_details.square_product string

Het Square-product, zoals Square Point of Sale (POS), Square Invoices of Square Virtual Terminal.

Applicatie-ID
payments.application_details.application_id string

De vierkante id die is toegewezen aan de toepassing die wordt gebruikt om de betaling te doen. Toepassingsontwikkelaars kunnen deze informatie gebruiken om betalingen te identificeren die door hun toepassing zijn verwerkt. Als een ontwikkelaar bijvoorbeeld een aangepaste toepassing gebruikt om betalingen te verwerken, bevat dit veld de toepassings-id van het ontwikkelaarsdashboard. Als een verkoper een Square App Marketplace-toepassing gebruikt om betalingen te verwerken, bevat het veld de bijbehorende toepassings-id.

Versietoken
payments.version_token string

Wordt gebruikt voor optimistische gelijktijdigheid. Dit ondoorzichtige token identificeert een specifieke versie van het betalingsobject.

Betalingsorder (bèta)

Betaal voor een bestelling met behulp van een of meer goedgekeurde betalingen of vereffen een bestelling met in totaal 0. Het totaal van de payment_ids die in de aanvraag wordt vermeld, moet gelijk zijn aan het ordertotaal. Orders met een totaal bedrag van 0 kunnen worden gemarkeerd als betaald door een lege matrix van payment_ids in de aanvraag op te geven.

Parameters

Name Sleutel Vereist Type Description
Order-id
order_id True string

De id van de order.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Betalings-id's
payment_ids array of string

Retouren

Name Pad Type Description
ID-kaart
order.id string

De unieke, door square uitgegeven id.

Locatie-id
order.location_id string

De id van de locatie.

Regelitems
order.line_items array of object
UID
order.line_items.uid string

De door het vierkant gegenereerde id.

Hoeveelheid
order.line_items.quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Naam
order.line_items.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Aantal
order.line_items.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.base_price_money.currency string

De valuta.

Aantal
order.line_items.gross_sales_money.amount integer

Het bedrag.

Valuta
order.line_items.gross_sales_money.currency string

De valuta.

Aantal
order.line_items.total_tax_money.amount integer

Het bedrag.

Valuta
order.line_items.total_tax_money.currency string

De valuta.

Aantal
order.line_items.total_discount_money.amount integer

Het bedrag.

Valuta
order.line_items.total_discount_money.currency string

De valuta.

Aantal
order.line_items.total_money.amount integer

Het bedrag.

Valuta
order.line_items.total_money.currency string

De valuta.

Gemaakt op
order.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
order.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Versie
order.version integer

De huidige versie van dit object.

Aantal
order.total_tax_money.amount integer

Het bedrag.

Valuta
order.total_tax_money.currency string

De valuta.

Aantal
order.total_discount_money.amount integer

Het bedrag.

Valuta
order.total_discount_money.currency string

De valuta.

Aantal
order.total_money.amount integer

Het bedrag.

Valuta
order.total_money.currency string

De valuta.

Gesloten om
order.closed_at string

De tijd waarop gesloten, in ISO 8601-indeling.

Offertes
order.tenders array of object
ID-kaart
order.tenders.id string

De id van het object

Locatie-id
order.tenders.location_id string

De locatie-id voor een ontvanger (anders dan de verkoper) die een deel van deze aanbesteding ontvangt.

Transactie-id
order.tenders.transaction_id string

De id van de bijbehorende transactie van de inschrijving.

Gemaakt op
order.tenders.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Aantal
order.tenders.amount_money.amount integer

Het bedrag.

Valuta
order.tenders.amount_money.currency string

De valuta.

Typologie
order.tenders.type string

Geeft het type aan.

Toestand
order.tenders.card_details.status string

De huidige status van de creditcardbetaling (zoals GEAUTORISEERD of VASTGELEGD)

Merk kaart
order.tenders.card_details.card.card_brand string

Het merk van de kaart.

last_4
order.tenders.card_details.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
order.tenders.card_details.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
order.tenders.card_details.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
order.tenders.card_details.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Invoermethode
order.tenders.card_details.entry_method string

De methode die wordt gebruikt om de details van de kaart voor de transactie in te voeren.

BetalingsID
order.tenders.payment_id string

Door vierkanten gegenereerde unieke id van de betaling.

Aantal
order.total_service_charge_money.amount integer

Het bedrag.

Valuta
order.total_service_charge_money.currency string

De valuta.

Aantal
order.net_amounts.total_money.amount integer

Het bedrag.

Valuta
order.net_amounts.total_money.currency string

De valuta.

Aantal
order.net_amounts.tax_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tax_money.currency string

De valuta.

Aantal
order.net_amounts.discount_money.amount integer

Het bedrag.

Valuta
order.net_amounts.discount_money.currency string

De valuta.

Aantal
order.net_amounts.tip_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tip_money.currency string

De valuta.

Aantal
order.net_amounts.service_charge_money.amount integer

Het bedrag.

Valuta
order.net_amounts.service_charge_money.currency string

De valuta.

Naam
order.source.name string

De naam.

Staat
order.state string

De huidige status.

Betalingsrestitutie aanvragen

Hiermee wordt een specifieke restitutie opgehaald met behulp van de refund_id.

Parameters

Name Sleutel Vereist Type Description
Restitutie-id
refund_id True string

De id van de restitutie.

Retouren

Name Pad Type Description
ID-kaart
refund.id string

De unieke, door square uitgegeven id.

Toestand
refund.status string

De huidige verificatiestatus van dit object.

Aantal
refund.amount_money.amount integer

Het bedrag.

Valuta
refund.amount_money.currency string

De valuta.

BetalingsID
refund.payment_id string

De unieke id van de betaling.

Order-id
refund.order_id string

De id van de order.

Gemaakt op
refund.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
refund.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Verwerkingskosten
refund.processing_fee array of object
Effectief op
refund.processing_fee.effective_at string

De tijdstempel van wanneer de vergoeding van kracht wordt, in RFC 3339-indeling.

Typologie
refund.processing_fee.type string

Geeft het type aan.

Aantal
refund.processing_fee.amount_money.amount integer

Het bedrag.

Valuta
refund.processing_fee.amount_money.currency string

De valuta.

Locatie-id
refund.location_id string

De id van de locatie.

Reden
refund.reason string

De reden voor dit object.

Betalingsrestituties vermelden

Hiermee wordt een lijst met restituties opgehaald voor het account dat de aanvraag indient. Resultaten zijn uiteindelijk consistent en nieuwe restituties of wijzigingen in restituties kunnen enkele seconden duren.

Parameters

Name Sleutel Vereist Type Description
Begintijd
begin_time string

De inclusieve begintijd van de query op opened_at, in ISO 8601-indeling.

Eindtijd
end_time string

De exclusieve einddatum van de query op opened_at, in ISO 8601-indeling.

Sorteervolgorde
sort_order string

Hiermee sorteert u de geretourneerde lijst op het moment dat de kaart is gemaakt met de opgegeven volgorde.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Toestand
status string

Indien opgegeven, worden alleen objecten geretourneerd die overeenkomen met de opgegeven statussen.

Brontype
source_type string

Indien opgegeven, worden alleen restituties geretourneerd met het opgegeven brontype.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Retouren

Name Pad Type Description
Restituties
refunds array of object
ID-kaart
refunds.id string

De unieke, door square uitgegeven id.

Toestand
refunds.status string

De huidige verificatiestatus van dit object.

Aantal
refunds.amount_money.amount integer

Het bedrag.

Valuta
refunds.amount_money.currency string

De valuta.

BetalingsID
refunds.payment_id string

De id van de betaling.

Order-id
refunds.order_id string

De id van de order.

Gemaakt op
refunds.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
refunds.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Verwerkingskosten
refunds.processing_fee array of object
Effectief op
refunds.processing_fee.effective_at string

De tijdstempel van wanneer de vergoeding van kracht wordt, in RFC 3339-indeling.

Typologie
refunds.processing_fee.type string

Het type van dit object.

Aantal
refunds.processing_fee.amount_money.amount integer

Het bedrag.

Valuta
refunds.processing_fee.amount_money.currency string

De valuta.

Locatie-id
refunds.location_id string

De id voor de locatie.

Reden
refunds.reason string

De reden van het geschil waarom de kaarthouder het geschil met zijn bank heeft geïnitieerd.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Bewijs indienen

Dient bewijs in bij de bank van de kaarthouder. Voordat het bewijs wordt ingediend, verzamelt Square alle beschikbare bewijzen. Dit omvat bewijs dat is geüpload met behulp van createDisputeEvidenceFile en CreateDisputeEvidenceText-eindpunten en bewijs dat automatisch wordt geleverd door Square, indien beschikbaar.

Parameters

Name Sleutel Vereist Type Description
Geschil-id
dispute_id True string

De id van het geschil.

Retouren

Name Pad Type Description
ID-kaart
dispute.id string

De unieke, door square uitgegeven id.

Aantal
dispute.amount_money.amount integer

Het bedrag.

Valuta
dispute.amount_money.currency string

De valuta.

Reden
dispute.reason string

De reden voor dit object.

Staat
dispute.state string

De huidige status.

Einddatum op
dispute.due_at string

Het tijdstip waarop de volgende actie moet worden uitgevoerd, in RFC 3339-indeling.

Betwiste betalingen
dispute.disputed_payments array of object
BetalingsID
dispute.disputed_payments.payment_id string

Door vierkanten gegenereerde unieke id van de betaling.

Merk kaart
dispute.card_brand string

Het merk van de kaart.

Gemaakt op
dispute.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
dispute.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Merkconflict-id
dispute.brand_dispute_id string

De id van het geschil in het merksysteem van de kaart, gegenereerd door het merk kaart.

Bewijs van geschil vermelden

Retourneert een lijst met bewijsmateriaal dat is gekoppeld aan een geschil.

Parameters

Name Sleutel Vereist Type Description
Geschil-id
dispute_id True string

De id van het geschil.

Retouren

Name Pad Type Description
Evidence
evidence array of object
ID-kaart
evidence.id string

De unieke, door square uitgegeven id.

Geschil-id
evidence.dispute_id string

De id van het geschil is gekoppeld aan het bewijs.

Tekst van bewijs
evidence.evidence_text string

De onbewerkte tekst.

Bewijstype
evidence.evidence_type string

Het type bewijs.

Geüpload op
evidence.uploaded_at string

Het tijdstip waarop de volgende actie moet worden uitgevoerd, in RFC 3339-indeling.

Bewijs-id
evidence.evidence_id string

De door square gegenereerde id van het bewijs.

Bestandsnaam
evidence.evidence_file.filename string

De bestandsnaam inclusief de bestandsextensie

Bestandstype
evidence.evidence_file.filetype string

Bewijsbestanden voor geschillen moeten application/pdf, image/heic, image/heif, image/jpeg, image/png of image/tiff-indelingen zijn.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Catalogusgegevens

Haalt informatie op over de Square Catalog-API, zoals limieten voor batchgrootten die kunnen worden gebruikt door het eindpunt BatchUpsertCatalogObjects.

Retouren

Name Pad Type Description
Maximaal aantal batch-upsert-objecten per batch
limits.batch_upsert_max_objects_per_batch integer

Het maximum aantal objecten dat in één batch kan worden weergegeven in een /v2/catalog/batch-upsert-aanvraag.

Batch Upsert Max Total Objects
limits.batch_upsert_max_total_objects integer

Het maximum aantal objecten dat in alle batches in een aanvraag /v2/catalog/batch-upsert kan worden weergegeven.

Maximale object-id's in Batch ophalen
limits.batch_retrieve_max_object_ids integer

Het maximum aantal object-id's dat kan worden weergegeven in een aanvraag /v2/catalog/batch-retrieve.

Maximum aantal pagina's zoeken
limits.search_max_page_limit integer

Het maximum aantal resultaten dat kan worden geretourneerd op een pagina van een /v2/catalog/search-antwoord.

Maximum aantal object-id's in Batch verwijderen
limits.batch_delete_max_object_ids integer

Het maximum aantal object-id's dat kan worden opgenomen in één /v2/catalog/batch-delete-aanvraag.

Maximum aantal item-id's voor itembelastingen bijwerken
limits.update_item_taxes_max_item_ids integer

Het maximum aantal item-id's dat kan worden opgenomen in één aanvraag /v2/catalog/update-item-tax.

Maximumbelasting van artikelbelastingen bijwerken om in te schakelen
limits.update_item_taxes_max_taxes_to_enable integer

Het maximum aantal btw-id's dat kan worden ingeschakeld in één aanvraag /v2/catalog/update-item-tax.

Maximumbelasting van itembelastingen bijwerken om uit te schakelen
limits.update_item_taxes_max_taxes_to_disable integer

Het maximum aantal belasting-id's dat moet worden uitgeschakeld die kunnen worden opgenomen in één aanvraag /v2/catalog/update-item-tax.

Wijzigingsfunctie voor items bijwerken bevat de maximum aantal item-id's
limits.update_item_modifier_lists_max_item_ids integer

Het maximum aantal belasting-id's dat moet worden uitgeschakeld die kunnen worden opgenomen in één aanvraag /v2/catalog/update-item-tax.

Wijzigingslijsten voor items bijwerken om maximale wijzigingslijsten in te schakelen
limits.update_item_modifier_lists_max_modifier_lists_to_enable integer

Het maximum aantal wijzigingslijst-id's dat moet worden ingeschakeld die kunnen worden opgenomen in één aanvraag /v2/catalog/update-item-modifier-lists.

Wijzigingslijsten voor items bijwerken voor lijsten met maximale wijzigingsfunctie om uit te schakelen
limits.update_item_modifier_lists_max_modifier_lists_to_disable integer

Het maximum aantal wijzigingslijst-id's dat moet worden uitgeschakeld die kunnen worden opgenomen in één aanvraag /v2/catalog/update-item-modifier-lists.

Catalogusobject ophalen

Retourneert één CatalogItem als een CatalogObject op basis van de opgegeven id. Het geretourneerde object bevat alle relevante CatalogItem-informatie, waaronder: CatalogItemVariation-onderliggende items, verwijzingen naar de objecten CatalogModifierList en de id's van alle CatalogTax-objecten die hierop van toepassing zijn.

Parameters

Name Sleutel Vereist Type Description
Object-ID
object_id True string

De id van het object.

Verwante objecten opnemen
include_related_objects boolean

Indien waar, bevat het antwoord aanvullende objecten die zijn gerelateerd aan het aangevraagde object, als volgt: Als het objectveld van het antwoord een CatalogItem bevat, worden de bijbehorende CatalogCategory-, CatalogTax-, CatalogImage- en CatalogModifierList-objecten geretourneerd in het related_objects veld van het antwoord. Als het objectveld van het antwoord een CatalogItemVariation bevat, wordt de bovenliggende CatalogItem geretourneerd in het related_objects veld van het antwoord.

Retouren

Name Pad Type Description
Typologie
object.type string

Het type van dit object.

ID-kaart
object.id string

De unieke, door square uitgegeven id.

Bijgewerkt op
object.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Versie
object.version integer

De huidige versie van dit object.

Wordt verwijderd
object.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

present_at_all_locations
object.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
object.item_data.name string

De naam.

Description
object.item_data.title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Categorie-ID
object.item_data.category_id string

De id van de categorie van het item, indien van toepassing.

Belastingidentificatienummers
object.item_data.tax_ids array of string
Variaties
object.item_data.variations array of object
Typologie
object.item_data.variations.type string

Het type van dit object.

ID-kaart
object.item_data.variations.id string

Een id die naar dit object in de catalogus verwijst.

Bijgewerkt op
object.item_data.variations.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling.

Versie
object.item_data.variations.version integer

De versie van het object. Wanneer u een object bijwerkt, moet de opgegeven versie overeenkomen met de versie in de database, anders wordt de schrijfbewerking geweigerd als conflicterend.

Wordt verwijderd
object.item_data.variations.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
object.item_data.variations.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Item-id
object.item_data.variations.item_variation_data.item_id string

De id van de CatalogItem die is gekoppeld aan deze itemvariatie.

Naam
object.item_data.variations.item_variation_data.name string

De naam van de itemvariatie. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Rangtelwoord
object.item_data.variations.item_variation_data.ordinal integer

De volgorde waarin deze itemvariatie moet worden weergegeven. Deze waarde is alleen-lezen. Bij schrijfbewerkingen wordt het rangtelwoord voor elke itemvariatie binnen een bovenliggende CatalogItem ingesteld op basis van de positie van de itemvariaties. Bij leesbewerkingen is de waarde niet gegarandeerd sequentiële of unieke waarden.

Prijstype
object.item_data.variations.item_variation_data.pricing_type string

Hiermee wordt aangegeven of de prijs van de artikelvariatie is vast of bepaald op het moment van verkoop.

Aantal
object.item_data.variations.item_variation_data.price_money.amount integer

Het bedrag.

Valuta
object.item_data.variations.item_variation_data.price_money.currency string

De valuta.

Catalogusobject verwijderen

Hiermee verwijdert u één CatalogObject op basis van de opgegeven id en retourneert u de set verwijderde id's in het antwoord. Verwijderen is een trapsgewijze gebeurtenis, zodat alle onderliggende elementen van het doelobject ook worden verwijderd. Als u bijvoorbeeld een CatalogItem verwijdert, worden ook alle onderliggende items van CatalogItemVariation verwijderd.

Parameters

Name Sleutel Vereist Type Description
Object-ID
object_id True string

De id van het object.

Retouren

Name Pad Type Description
Verwijderde object-id's
deleted_object_ids array of string
Verwijderd op
deleted_at string

De tijdstempel van de database van deze verwijdering in RFC 3339-indeling

Catalogusobjecten batchgewijs verwijderen

Hiermee verwijdert u een set CatalogItems op basis van de opgegeven lijst met doel-id's en retourneert u een set verwijderde id's in het antwoord.

Parameters

Name Sleutel Vereist Type Description
Object-id's
object_ids array of string

Retouren

Name Pad Type Description
Verwijderde object-id's
deleted_object_ids array of string
Verwijderd op
deleted_at string

De tijdstempel van de database van deze verwijdering in RFC 3339-indeling

Catalogusobjecten zoeken

Hiermee wordt gezocht naar CatalogObject van elk type door overeenkomende ondersteunde zoekkenmerkwaarden, met uitzondering van aangepaste kenmerkwaarden voor items of itemvariaties, op basis van een of meer van de opgegeven queryfilters.

Parameters

Name Sleutel Vereist Type Description
Objecttypen
object_types array of string
Kenmerknaam
attribute_name string

De naam van het kenmerk dat moet worden doorzocht.

Kenmerkvoorvoegsel
attribute_prefix string

Het gewenste voorvoegsel van de waarde van het zoekkenmerk.

Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Retouren

Name Pad Type Description
Objects
objects array of object
Typologie
objects.type string

Het type van dit object.

ID-kaart
objects.id string

De unieke, door square uitgegeven id.

Bijgewerkt op
objects.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
objects.version integer

De huidige versie van het object.

Wordt verwijderd
objects.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
objects.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
objects.item_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Description
objects.item_data.title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Categorie-ID
objects.item_data.category_id string

De id van de categorie van het item, indien van toepassing.

Producttype
objects.item_data.product_type string

De queryexpressie voor producttypen voor het retourneren van items of itemvariaties met de opgegeven producttypen.

Belastingidentificatienummers
objects.item_data.tax_ids array of string
Variaties
objects.item_data.variations array of object
Typologie
objects.item_data.variations.type string

Het type van dit object. Elk objecttype heeft verwachte eigenschappen uitgedrukt in een gestructureerde indeling binnen het bijbehorende *_data veld hieronder.

ID-kaart
objects.item_data.variations.id string

Een id om naar dit object te verwijzen.

Bijgewerkt op
objects.item_data.variations.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
objects.item_data.variations.version integer

De versie van het object. Wanneer u een object bijwerkt, moet de opgegeven versie overeenkomen met de versie in de database, anders wordt de schrijfbewerking geweigerd als conflicterend.

Wordt verwijderd
objects.item_data.variations.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
objects.item_data.variations.present_at_all_locations boolean

Een lijst met locaties waar het object aanwezig is, zelfs als present_at_all_locations onwaar is. Dit kunnen locaties zijn die zijn gedeactiveerd.

Item-id
objects.item_data.variations.item_variation_data.item_id string

De id van het object met deze itemvariatie.

Naam
objects.item_data.variations.item_variation_data.name string

De naam van dit item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Rangtelwoord
objects.item_data.variations.item_variation_data.ordinal integer

De volgorde waarin deze itemvariatie moet worden weergegeven. Deze waarde is alleen-lezen.

Aantal
objects.item_data.variations.item_variation_data.price_money.amount integer

Het bedrag van het geld, in de kleinste benaming van de valuta aangegeven door valuta. Als valuta bijvoorbeeld USD is, is het bedrag in centen. Monetaire bedragen kunnen positief of negatief zijn. Zie de beschrijving van het specifieke veld om de betekenis van het teken in een bepaald geval te bepalen.

Valuta
objects.item_data.variations.item_variation_data.price_money.currency string

Het type valuta, in ISO 4217-indeling. De valutacode voor Amerikaanse dollars is bijvoorbeeld USD.

Prijstype
objects.item_data.variations.item_variation_data.pricing_type string

Hiermee wordt aangegeven of de prijs van de artikelvariatie is vast of bepaald op het moment van verkoop.

Zichtbaarheid
objects.item_data.visibility string

De zichtbaarheid.

Check-outs voor zoekterminals

Hiermee wordt een gefilterde lijst opgehaald met Terminal-uitcheckaanvragen die zijn gemaakt door het account dat de aanvraag indient.

Parameters

Name Sleutel Vereist Type Description
Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Toestand
status string

De huidige status.

Retouren

Name Pad Type Description
Uitchecken
checkouts array of object
ID-kaart
checkouts.id string

De unieke, door square uitgegeven id.

Aantal
checkouts.amount_money.amount integer

Het bedrag.

Valuta
checkouts.amount_money.currency string

De valuta.

Referentie-id
checkouts.reference_id string

Een optionele tweede id die wordt gebruikt om het klantprofiel te koppelen aan een entiteit in een ander systeem.

Opmerking
checkouts.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Apparaat-id
checkouts.device_options.device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalCheckout.

Tipping toestaan
checkouts.device_options.tip_settings.allow_tipping boolean

Geeft aan of tipping is ingeschakeld voor deze betaling. Standaard ingesteld op onwaar.

Ontvangstbewijsscherm overslaan
checkouts.device_options.skip_receipt_screen boolean

Hiermee geeft u het apparaat de opdracht om het ontvangstscherm over te slaan. Standaard ingesteld op onwaar.

Toestand
checkouts.status string

De huidige verificatiestatus van dit object.

Betalings-id's
checkouts.payment_ids array of string
Gemaakt op
checkouts.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
checkouts.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

App-id
checkouts.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Deadlineduur
checkouts.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Domein registreren voor Apple Pay

Hiermee activeert u een domein voor gebruik met Apple Pay op het web en square. Er wordt een validatie uitgevoerd op dit domein door Apple om ervoor te zorgen dat het domein correct is ingesteld als een domein met Apple Pay.

Parameters

Name Sleutel Vereist Type Description
Domeinnaam
domain_name True string

Een domeinnaam zoals beschreven in RFC-1034 die wordt geregistreerd bij Apple Pay.

Retouren

Name Pad Type Description
Toestand
status string

De status van de domeinregistratie.

Facturen weergeven

Retourneert een lijst met facturen voor een bepaalde locatie.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Retouren

Name Pad Type Description
Invoices
invoices array of object
ID-kaart
invoices.id string

De unieke, door square uitgegeven id.

Versie
invoices.version integer

De huidige versie van het object.

Locatie-id
invoices.location_id string

De id voor de locatie.

Order-id
invoices.order_id string

De id van de order.

Betalingsaanvragen
invoices.payment_requests array of object
UID
invoices.payment_requests.uid string

De door square gegenereerde id van de betalingsaanvraag in een factuur.

Aanvraagtype
invoices.payment_requests.request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
invoices.payment_requests.due_date string

De einddatum (in de tijdzone van de factuur) voor de betalingsaanvraag, in JJJJ-MM-DD notatie.

Tipping ingeschakeld
invoices.payment_requests.tipping_enabled boolean

Als deze optie is ingesteld op waar, biedt de door square gehoste factuurpagina (het public_url veld van de factuur) een plaats waar de klant een tip kan betalen.

Herinneringen
invoices.payment_requests.reminders array of object

Herinneringen

UID
invoices.payment_requests.reminders.uid string

Een door square toegewezen id die de herinnering uniek identificeert binnen de InvoicePaymentRequest.

Relatieve geplande dagen
invoices.payment_requests.reminders.relative_scheduled_days integer

Het aantal dagen vóór (een negatief getal) of na (een positief getal) de betalingsaanvraag due_date wanneer de herinnering wordt verzonden.

Message
invoices.payment_requests.reminders.message string

Het herinneringsbericht.

Toestand
invoices.payment_requests.reminders.status string

De status van de herinnering.

Aantal
invoices.payment_requests.computed_amount_money.amount integer

Het bedrag.

Valuta
invoices.payment_requests.computed_amount_money.currency string

De valuta.

Aantal
invoices.payment_requests.total_completed_amount_money.amount integer

Het bedrag.

Valuta
invoices.payment_requests.total_completed_amount_money.currency string

De valuta.

Automatische betalingsbron
invoices.payment_requests.automatic_payment_source string

De betalingswijze voor een automatische betaling.

Aangevraagd percentage
invoices.payment_requests.percentage_requested string

Hiermee geeft u het bedrag voor de betalingsaanvraag in percentage.

Kaart-id
invoices.payment_requests.card_id string

De id van de creditcard of betaalpas in het bestand om kosten in rekening te brengen voor de betalingsaanvraag.

Factuurnummer
invoices.invoice_number string

Een gebruiksvriendelijk factuurnummer.

Title
invoices.title string

De titel van de factuur.

Description
invoices.description string

De beschrijving.

Gepland op
invoices.scheduled_at string

De tijdstempel wanneer de factuur is gepland voor verwerking, in RFC 3339-indeling. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op de opgegeven datum, volgens de leveringsmethode en instellingen voor betalingsaanvragen.

Toestand
invoices.status string

De huidige verificatiestatus van dit object.

Timezone
invoices.timezone string

De tijdzone die wordt gebruikt om kalenderdatums op de factuur te interpreteren, zoals due_date. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Gemaakt op
invoices.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
invoices.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Klant-id
invoices.primary_recipient.customer_id string

De id van een klant die aan de kaart moet worden gekoppeld.

Voornaam
invoices.primary_recipient.given_name string

De naam van de geadresseerde (dat wil gezegd, voornaam).

Achternaam
invoices.primary_recipient.family_name string

De familienaam van de ontvanger (dat wil gezegd achternaam).

E-mailadres
invoices.primary_recipient.email_address string

Het e-mailadres van de geadresseerde.

Telefoonnummer
invoices.primary_recipient.phone_number string

Het telefoonnummer van de geadresseerde.

Card
invoices.accepted_payment_methods.card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
invoices.accepted_payment_methods.square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
invoices.accepted_payment_methods.bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Aangepaste velden
invoices.custom_fields array of object
Etiket
invoices.custom_fields.label string

Het label of de titel van het aangepaste veld.

Waarde
invoices.custom_fields.value string

De tekst van het aangepaste veld.

Plaatsing
invoices.custom_fields.placement string

De locatie van het aangepaste veld op de factuur

Leveringsmethode
invoices.delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden.

Verkoop- of servicedatum
invoices.sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Openbare URL
invoices.public_url string

De URL van de door square gehoste factuurpagina. Nadat u de factuur hebt gepubliceerd met behulp van het PublishInvoice-eindpunt, host Square de factuurpagina en retourneert de pagina-URL in het antwoord.

Aantal
invoices.next_payment_amount_money.amount integer

Het bedrag.

Valuta
invoices.next_payment_amount_money.currency string

De valuta.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Facturen zoeken

Zoekt naar facturen vanaf een locatie die is opgegeven in het filter.

Parameters

Name Sleutel Vereist Type Description
Locatie-id's
location_ids array of string
Klant-id's
customer_ids array of string
Veld
field string

Gebruik een of meer klantkenmerken als sorteersleutel om doorzochte klantprofielen te sorteren.

Bestelling
order string

Geeft de volgorde aan waarin de resultaten moeten worden gesorteerd op basis van de waarde van het sorteerveld. Tekenreeksen gebruiken standaard alfabetische vergelijking om de volgorde te bepalen.

Limit
limit integer

Het maximum aantal facturen dat moet worden geretourneerd (200 is de maximumlimiet). Indien niet opgegeven, gebruikt de server een standaardlimiet van 100 facturen.

Retouren

Name Pad Type Description
Invoices
invoices array of object
ID-kaart
invoices.id string

De unieke, door square uitgegeven id.

Versie
invoices.version integer

De huidige versie van het object.

Locatie-id
invoices.location_id string

De id voor de locatie.

Order-id
invoices.order_id string

De id van de order.

Betalingsaanvragen
invoices.payment_requests array of object
UID
invoices.payment_requests.uid string

De door square gegenereerde id van de betalingsaanvraag in een factuur.

Aanvraagtype
invoices.payment_requests.request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
invoices.payment_requests.due_date string

De einddatum (in de tijdzone van de factuur) voor de betalingsaanvraag, in JJJJ-MM-DD notatie.

Tipping ingeschakeld
invoices.payment_requests.tipping_enabled boolean

Als deze optie is ingesteld op waar, biedt de door square gehoste factuurpagina (het public_url veld van de factuur) een plaats waar de klant een tip kan betalen.

Herinneringen
invoices.payment_requests.reminders array of object

Herinneringen

UID
invoices.payment_requests.reminders.uid string

Een door square toegewezen id die de herinnering uniek identificeert binnen de InvoicePaymentRequest.

Relatieve geplande dagen
invoices.payment_requests.reminders.relative_scheduled_days integer

Het aantal dagen vóór (een negatief getal) of na (een positief getal) de betalingsaanvraag due_date wanneer de herinnering wordt verzonden.

Message
invoices.payment_requests.reminders.message string

Het herinneringsbericht.

Toestand
invoices.payment_requests.reminders.status string

De status van de herinnering.

Aantal
invoices.payment_requests.computed_amount_money.amount integer

Het bedrag.

Valuta
invoices.payment_requests.computed_amount_money.currency string

De valuta.

Aantal
invoices.payment_requests.total_completed_amount_money.amount integer

Het bedrag.

Valuta
invoices.payment_requests.total_completed_amount_money.currency string

De valuta.

Automatische betalingsbron
invoices.payment_requests.automatic_payment_source string

De betalingswijze voor een automatische betaling.

Aangevraagd percentage
invoices.payment_requests.percentage_requested string

Hiermee geeft u het bedrag voor de betalingsaanvraag in percentage.

Kaart-id
invoices.payment_requests.card_id string

De id van de creditcard of betaalpas in het bestand om kosten in rekening te brengen voor de betalingsaanvraag.

Factuurnummer
invoices.invoice_number string

Een gebruiksvriendelijk factuurnummer.

Title
invoices.title string

De titel van de factuur.

Description
invoices.description string

De beschrijving.

Gepland op
invoices.scheduled_at string

De tijdstempel wanneer de factuur is gepland voor verwerking, in RFC 3339-indeling. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op de opgegeven datum, volgens de leveringsmethode en instellingen voor betalingsaanvragen.

Toestand
invoices.status string

De huidige verificatiestatus van dit object.

Timezone
invoices.timezone string

De tijdzone die wordt gebruikt om kalenderdatums op de factuur te interpreteren, zoals due_date. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Gemaakt op
invoices.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
invoices.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Klant-id
invoices.primary_recipient.customer_id string

De id van een klant die aan de kaart moet worden gekoppeld.

Voornaam
invoices.primary_recipient.given_name string

De naam van de geadresseerde (dat wil gezegd, voornaam).

Achternaam
invoices.primary_recipient.family_name string

De familienaam van de ontvanger (dat wil gezegd achternaam).

E-mailadres
invoices.primary_recipient.email_address string

Het e-mailadres van de geadresseerde.

Telefoonnummer
invoices.primary_recipient.phone_number string

Het telefoonnummer van de geadresseerde.

Card
invoices.accepted_payment_methods.card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
invoices.accepted_payment_methods.square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
invoices.accepted_payment_methods.bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Aangepaste velden
invoices.custom_fields array of object
Etiket
invoices.custom_fields.label string

Het label of de titel van het aangepaste veld.

Waarde
invoices.custom_fields.value string

De tekst van het aangepaste veld.

Plaatsing
invoices.custom_fields.placement string

De locatie van het aangepaste veld op de factuur

Leveringsmethode
invoices.delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden.

Verkoop- of servicedatum
invoices.sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Openbare URL
invoices.public_url string

De URL van de door square gehoste factuurpagina. Nadat u de factuur hebt gepubliceerd met behulp van het PublishInvoice-eindpunt, host Square de factuurpagina en retourneert de pagina-URL in het antwoord.

Aantal
invoices.next_payment_amount_money.amount integer

Het bedrag.

Valuta
invoices.next_payment_amount_money.currency string

De valuta.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Factuur annuleren

Annuleert een factuur. De verkoper kan geen betalingen voor de geannuleerde factuur verzamelen.

Parameters

Name Sleutel Vereist Type Description
Factuur-id
invoice_id True string

De id van de factuur.

Versie
version integer

De versie.

Retouren

Name Pad Type Description
ID-kaart
invoice.id string

De unieke, door square uitgegeven id.

Versie
invoice.version integer

De huidige versie van dit object.

Locatie-id
invoice.location_id string

De id van de locatie.

Order-id
invoice.order_id string

De id van de order.

Betalingsaanvragen
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

De door het vierkant gegenereerde id.

Aanvraagtype
invoice.payment_requests.request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
invoice.payment_requests.due_date string

De vervaldatum voor de betalingsaanvraag, in de indeling JJJJ-MM-DD.

Tipping ingeschakeld
invoice.payment_requests.tipping_enabled boolean

Als deze optie is ingesteld op true, biedt de klant een plaats om een tip te betalen.

Herinneringen
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Een door een vierkant toegewezen id.

Relatieve geplande dagen
invoice.payment_requests.reminders.relative_scheduled_days integer

Het aantal dagen vóór (een negatief getal) of na (een positief getal) de betalingsaanvraag due_date wanneer de herinnering wordt verzonden.

Message
invoice.payment_requests.reminders.message string

Het bericht.

Toestand
invoice.payment_requests.reminders.status string

De huidige status.

Aantal
invoice.payment_requests.computed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.computed_amount_money.currency string

De valuta.

Aantal
invoice.payment_requests.total_completed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.total_completed_amount_money.currency string

De valuta.

Automatische betalingsbron
invoice.payment_requests.automatic_payment_source string

De betalingswijze voor een automatische betaling.

Factuurnummer
invoice.invoice_number string

Een gebruiksvriendelijk factuurnummer. De waarde is uniek binnen een locatie. Als dit niet wordt opgegeven bij het maken van een factuur, wijst Square een waarde toe.

Title
invoice.title string

De titel.

Description
invoice.description string

De beschrijving.

Gepland op
invoice.scheduled_at string

De tijdstempel wanneer de verwerking is gepland, in RFC 3339-indeling.

Toestand
invoice.status string

De huidige verificatiestatus van dit object.

Timezone
invoice.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Gemaakt op
invoice.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
invoice.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klant-id
invoice.primary_recipient.customer_id string

De id van de klant die aan de order is gekoppeld.

Voornaam
invoice.primary_recipient.given_name string

De naam van de geadresseerde (dat wil gezegd, voornaam).

Achternaam
invoice.primary_recipient.family_name string

De familienaam van de ontvanger (dat wil gezegd achternaam).

E-mailadres
invoice.primary_recipient.email_address string

Het e-mailadres van de geadresseerde.

Telefoonnummer
invoice.primary_recipient.phone_number string

Het telefoonnummer van de geadresseerde.

Card
invoice.accepted_payment_methods.card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
invoice.accepted_payment_methods.square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
invoice.accepted_payment_methods.bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Aangepaste velden
invoice.custom_fields array of object
Etiket
invoice.custom_fields.label string

Het label of de titel van het aangepaste veld.

Waarde
invoice.custom_fields.value string

De tekst van het aangepaste veld.

Plaatsing
invoice.custom_fields.placement string

De locatie van het aangepaste veld op de factuur.

Leveringsmethode
invoice.delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op basis van de instellingen voor de leveringswijze en betalingsaanvraag, direct of op de scheduled_at datum, indien opgegeven.

Verkoop- of servicedatum
invoice.sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Factuur bijwerken

Hiermee werkt u een factuur bij door velden te wijzigen, velden te wissen of beide.

Parameters

Name Sleutel Vereist Type Description
Factuur-id
invoice_id True string

De id van de factuur.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

UID
uid string

De door het vierkant gegenereerde id.

Tipping ingeschakeld
tipping_enabled boolean

Als deze optie is ingesteld op true, biedt de klant een plaats om een tip te betalen.

Te wissen velden
fields_to_clear array of string

Retouren

Name Pad Type Description
ID-kaart
invoice.id string

De unieke, door square uitgegeven id.

Versie
invoice.version integer

De huidige versie van dit object.

Locatie-id
invoice.location_id string

De id van de locatie.

Order-id
invoice.order_id string

De id van de order.

Betalingsaanvragen
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

De door het vierkant gegenereerde id.

Aanvraagtype
invoice.payment_requests.request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
invoice.payment_requests.due_date string

De vervaldatum voor de betalingsaanvraag, in de indeling JJJJ-MM-DD.

Tipping ingeschakeld
invoice.payment_requests.tipping_enabled boolean

Als deze optie is ingesteld op true, biedt de klant een plaats om een tip te betalen.

Aantal
invoice.payment_requests.computed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.computed_amount_money.currency string

De valuta.

Aantal
invoice.payment_requests.total_completed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.total_completed_amount_money.currency string

De valuta.

Automatische betalingsbron
invoice.payment_requests.automatic_payment_source string

De betalingswijze voor een automatische betaling.

Factuurnummer
invoice.invoice_number string

Een gebruiksvriendelijk factuurnummer. De waarde is uniek binnen een locatie. Als dit niet wordt opgegeven bij het maken van een factuur, wijst Square een waarde toe.

Title
invoice.title string

De titel.

Description
invoice.description string

De beschrijving.

Gepland op
invoice.scheduled_at string

De tijdstempel wanneer de verwerking is gepland, in RFC 3339-indeling.

Toestand
invoice.status string

De huidige verificatiestatus van dit object.

Timezone
invoice.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Gemaakt op
invoice.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
invoice.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klant-id
invoice.primary_recipient.customer_id string

De id van de klant die aan de order is gekoppeld.

Voornaam
invoice.primary_recipient.given_name string

De naam van de geadresseerde (dat wil gezegd, voornaam).

Achternaam
invoice.primary_recipient.family_name string

De familienaam van de ontvanger (dat wil gezegd achternaam).

E-mailadres
invoice.primary_recipient.email_address string

Het e-mailadres van de geadresseerde.

Telefoonnummer
invoice.primary_recipient.phone_number string

Het telefoonnummer van de geadresseerde.

Aantal
invoice.next_payment_amount_money.amount integer

Het bedrag.

Valuta
invoice.next_payment_amount_money.currency string

De valuta.

Card
invoice.accepted_payment_methods.card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
invoice.accepted_payment_methods.square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
invoice.accepted_payment_methods.bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Aangepaste velden
invoice.custom_fields array of object
Etiket
invoice.custom_fields.label string

Het label of de titel van het aangepaste veld.

Waarde
invoice.custom_fields.value string

De tekst van het aangepaste veld.

Plaatsing
invoice.custom_fields.placement string

De locatie van het aangepaste veld op de factuur.

Leveringsmethode
invoice.delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op basis van de instellingen voor de leveringswijze en betalingsaanvraag, direct of op de scheduled_at datum, indien opgegeven.

Verkoop- of servicedatum
invoice.sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Factuur maken

Hiermee maakt u een conceptfactuur voor een order die is gemaakt met behulp van de Orders-API. Er blijft een conceptfactuur in uw account en er wordt geen actie ondernomen. U moet de factuur publiceren voordat Square deze kan verwerken (stuur deze naar het e-mailadres van de klant of laad de kaart van de klant in het bestand).

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Locatie-id
location_id string

De id van de locatie.

Order-id
order_id string

De id van de order.

Gepland op
scheduled_at string

De tijdstempel wanneer de verwerking is gepland, in RFC 3339-indeling.

Klant-id
customer_id string

De id van de klant die aan de order is gekoppeld.

Leveringsmethode
delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op basis van de instellingen voor de leveringswijze en betalingsaanvraag, direct of op de scheduled_at datum, indien opgegeven.

Aanvraagtype
request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
due_date string

De vervaldatum voor de betalingsaanvraag, in de indeling JJJJ-MM-DD.

Tipping ingeschakeld
tipping_enabled boolean

Als deze optie is ingesteld op true, biedt de klant een plaats om een tip te betalen.

Automatische betalingsbron
automatic_payment_source string

De betalingswijze voor een automatische betaling.

Message
message string

Het bericht.

Relatieve geplande dagen
relative_scheduled_days integer

Het aantal dagen vóór (een negatief getal) of na (een positief getal) de betalingsaanvraag due_date wanneer de herinnering wordt verzonden.

Factuurnummer
invoice_number string

Een gebruiksvriendelijk factuurnummer. De waarde is uniek binnen een locatie. Als dit niet wordt opgegeven bij het maken van een factuur, wijst Square een waarde toe.

Title
title string

De titel.

Description
description string

De beschrijving.

Card
card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Etiket
label string

Het label of de titel van het aangepaste veld.

Waarde
value string

De tekst van het aangepaste veld.

Plaatsing
placement string

De locatie van het aangepaste veld op de factuur.

Verkoop- of servicedatum
sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Retouren

Name Pad Type Description
ID-kaart
invoice.id string

De unieke, door square uitgegeven id.

Versie
invoice.version integer

De huidige versie van dit object.

Locatie-id
invoice.location_id string

De id van de locatie.

Order-id
invoice.order_id string

De id van de order.

Betalingsaanvragen
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

De door het vierkant gegenereerde id.

Aanvraagtype
invoice.payment_requests.request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
invoice.payment_requests.due_date string

De vervaldatum voor de betalingsaanvraag, in de indeling JJJJ-MM-DD.

Tipping ingeschakeld
invoice.payment_requests.tipping_enabled boolean

Als deze optie is ingesteld op true, biedt de klant een plaats om een tip te betalen.

Herinneringen
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Een door een vierkant toegewezen id.

Relatieve geplande dagen
invoice.payment_requests.reminders.relative_scheduled_days integer

Het aantal dagen vóór (een negatief getal) of na (een positief getal) de betalingsaanvraag due_date wanneer de herinnering wordt verzonden.

Message
invoice.payment_requests.reminders.message string

Het bericht.

Toestand
invoice.payment_requests.reminders.status string

De huidige status.

Aantal
invoice.payment_requests.computed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.computed_amount_money.currency string

De valuta.

Aantal
invoice.payment_requests.total_completed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.total_completed_amount_money.currency string

De valuta.

Automatische betalingsbron
invoice.payment_requests.automatic_payment_source string

De betalingswijze voor een automatische betaling.

Factuurnummer
invoice.invoice_number string

Een gebruiksvriendelijk factuurnummer. De waarde is uniek binnen een locatie. Als dit niet wordt opgegeven bij het maken van een factuur, wijst Square een waarde toe.

Title
invoice.title string

De titel.

Description
invoice.description string

De beschrijving.

Gepland op
invoice.scheduled_at string

De tijdstempel wanneer de verwerking is gepland, in RFC 3339-indeling.

Toestand
invoice.status string

De huidige verificatiestatus van dit object.

Timezone
invoice.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Gemaakt op
invoice.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
invoice.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klant-id
invoice.primary_recipient.customer_id string

De id van de klant die aan de order is gekoppeld.

Voornaam
invoice.primary_recipient.given_name string

De naam van de geadresseerde (dat wil gezegd, voornaam).

Achternaam
invoice.primary_recipient.family_name string

De familienaam van de ontvanger (dat wil gezegd achternaam).

E-mailadres
invoice.primary_recipient.email_address string

Het e-mailadres van de geadresseerde.

Telefoonnummer
invoice.primary_recipient.phone_number string

Het telefoonnummer van de geadresseerde.

Card
invoice.accepted_payment_methods.card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
invoice.accepted_payment_methods.square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
invoice.accepted_payment_methods.bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Aangepaste velden
invoice.custom_fields array of object
Etiket
invoice.custom_fields.label string

Het label of de titel van het aangepaste veld.

Waarde
invoice.custom_fields.value string

De tekst van het aangepaste veld.

Plaatsing
invoice.custom_fields.placement string

De locatie van het aangepaste veld op de factuur.

Leveringsmethode
invoice.delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op basis van de instellingen voor de leveringswijze en betalingsaanvraag, direct of op de scheduled_at datum, indien opgegeven.

Verkoop- of servicedatum
invoice.sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Factuur ophalen

Hiermee haalt u een factuur op factuur-id op.

Parameters

Name Sleutel Vereist Type Description
Factuur-id
invoice_id True string

De id van de factuur.

Retouren

Name Pad Type Description
ID-kaart
invoice.id string

De unieke, door square uitgegeven id.

Versie
invoice.version integer

De huidige versie van dit object.

Locatie-id
invoice.location_id string

De id van de locatie.

Order-id
invoice.order_id string

De id van de order.

Betalingsaanvragen
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

De door het vierkant gegenereerde id.

Aanvraagtype
invoice.payment_requests.request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
invoice.payment_requests.due_date string

De vervaldatum voor de betalingsaanvraag, in de indeling JJJJ-MM-DD.

Tipping ingeschakeld
invoice.payment_requests.tipping_enabled boolean

Als deze optie is ingesteld op true, biedt de klant een plaats om een tip te betalen.

Herinneringen
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Een door een vierkant toegewezen id.

Relatieve geplande dagen
invoice.payment_requests.reminders.relative_scheduled_days integer

Het aantal dagen vóór (een negatief getal) of na (een positief getal) de betalingsaanvraag due_date wanneer de herinnering wordt verzonden.

Message
invoice.payment_requests.reminders.message string

Het bericht.

Toestand
invoice.payment_requests.reminders.status string

De huidige status.

Aantal
invoice.payment_requests.computed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.computed_amount_money.currency string

De valuta.

Aantal
invoice.payment_requests.total_completed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.total_completed_amount_money.currency string

De valuta.

Automatische betalingsbron
invoice.payment_requests.automatic_payment_source string

De betalingswijze voor een automatische betaling.

Factuurnummer
invoice.invoice_number string

Een gebruiksvriendelijk factuurnummer. De waarde is uniek binnen een locatie. Als dit niet wordt opgegeven bij het maken van een factuur, wijst Square een waarde toe.

Title
invoice.title string

De titel.

Description
invoice.description string

De beschrijving.

Gepland op
invoice.scheduled_at string

De tijdstempel wanneer de verwerking is gepland, in RFC 3339-indeling.

Toestand
invoice.status string

De huidige verificatiestatus van dit object.

Timezone
invoice.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Gemaakt op
invoice.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
invoice.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klant-id
invoice.primary_recipient.customer_id string

De id van de klant die aan de order is gekoppeld.

Voornaam
invoice.primary_recipient.given_name string

De naam van de geadresseerde (dat wil gezegd, voornaam).

Achternaam
invoice.primary_recipient.family_name string

De familienaam van de ontvanger (dat wil gezegd achternaam).

E-mailadres
invoice.primary_recipient.email_address string

Het e-mailadres van de geadresseerde.

Telefoonnummer
invoice.primary_recipient.phone_number string

Het telefoonnummer van de geadresseerde.

Card
invoice.accepted_payment_methods.card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
invoice.accepted_payment_methods.square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
invoice.accepted_payment_methods.bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Aangepaste velden
invoice.custom_fields array of object
Etiket
invoice.custom_fields.label string

Het label of de titel van het aangepaste veld.

Waarde
invoice.custom_fields.value string

De tekst van het aangepaste veld.

Plaatsing
invoice.custom_fields.placement string

De locatie van het aangepaste veld op de factuur.

Leveringsmethode
invoice.delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op basis van de instellingen voor de leveringswijze en betalingsaanvraag, direct of op de scheduled_at datum, indien opgegeven.

Verkoop- of servicedatum
invoice.sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Factuur publiceren

Hiermee publiceert u de opgegeven conceptfactuur. Nadat een factuur is gepubliceerd, wordt Square opvolgen op basis van de factuurconfiguratie. Square verzendt bijvoorbeeld de factuur naar het e-mailadres van de klant, brengt de kaart van de klant in rekening of doet niets. Square maakt de factuur ook beschikbaar op een door Square gehoste factuurpagina.

Parameters

Name Sleutel Vereist Type Description
Factuur-id
invoice_id True string

De id van de factuur.

Versie
version integer

De versie.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

Name Pad Type Description
ID-kaart
invoice.id string

De unieke, door square uitgegeven id.

Versie
invoice.version integer

De huidige versie van dit object.

Locatie-id
invoice.location_id string

De id van de locatie.

Order-id
invoice.order_id string

De id van de order.

Betalingsaanvragen
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

De door het vierkant gegenereerde id.

Aanvraagtype
invoice.payment_requests.request_type string

Hiermee wordt het type betalingsaanvraag geïdentificeerd. Dit type definieert hoe het bedrag van de betalingsaanvraag wordt bepaald.

Vervaldag
invoice.payment_requests.due_date string

De vervaldatum voor de betalingsaanvraag, in de indeling JJJJ-MM-DD.

Tipping ingeschakeld
invoice.payment_requests.tipping_enabled boolean

Als deze optie is ingesteld op true, biedt de klant een plaats om een tip te betalen.

Herinneringen
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Een door een vierkant toegewezen id.

Relatieve geplande dagen
invoice.payment_requests.reminders.relative_scheduled_days integer

Het aantal dagen vóór (een negatief getal) of na (een positief getal) de betalingsaanvraag due_date wanneer de herinnering wordt verzonden.

Message
invoice.payment_requests.reminders.message string

Het bericht.

Toestand
invoice.payment_requests.reminders.status string

De huidige status.

Aantal
invoice.payment_requests.computed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.computed_amount_money.currency string

De valuta.

Aantal
invoice.payment_requests.total_completed_amount_money.amount integer

Het bedrag.

Valuta
invoice.payment_requests.total_completed_amount_money.currency string

De valuta.

Automatische betalingsbron
invoice.payment_requests.automatic_payment_source string

De betalingswijze voor een automatische betaling.

Factuurnummer
invoice.invoice_number string

Een gebruiksvriendelijk factuurnummer. De waarde is uniek binnen een locatie. Als dit niet wordt opgegeven bij het maken van een factuur, wijst Square een waarde toe.

Title
invoice.title string

De titel.

Description
invoice.description string

De beschrijving.

Gepland op
invoice.scheduled_at string

De tijdstempel wanneer de verwerking is gepland, in RFC 3339-indeling.

Toestand
invoice.status string

De huidige verificatiestatus van dit object.

Timezone
invoice.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Gemaakt op
invoice.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
invoice.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klant-id
invoice.primary_recipient.customer_id string

De id van de klant die aan de order is gekoppeld.

Voornaam
invoice.primary_recipient.given_name string

De naam van de geadresseerde (dat wil gezegd, voornaam).

Achternaam
invoice.primary_recipient.family_name string

De familienaam van de ontvanger (dat wil gezegd achternaam).

E-mailadres
invoice.primary_recipient.email_address string

Het e-mailadres van de geadresseerde.

Telefoonnummer
invoice.primary_recipient.phone_number string

Het telefoonnummer van de geadresseerde.

Openbare URL
invoice.public_url string

De URL van de door square gehoste factuurpagina. Nadat u de factuur hebt gepubliceerd met behulp van het PublishInvoice-eindpunt, host Square de factuurpagina en retourneert de pagina-URL in het antwoord.

Card
invoice.accepted_payment_methods.card boolean

Hiermee wordt aangegeven of creditcard- of betaalpasbetalingen worden geaccepteerd.

Vierkante cadeaukaart
invoice.accepted_payment_methods.square_gift_card boolean

Hiermee wordt aangegeven of betalingen van vierkante cadeaukaarten worden geaccepteerd.

Bankrekening
invoice.accepted_payment_methods.bank_account boolean

Hiermee wordt aangegeven of bankoverschrijvingen worden geaccepteerd.

Aangepaste velden
invoice.custom_fields array of object
Etiket
invoice.custom_fields.label string

Het label of de titel van het aangepaste veld.

Waarde
invoice.custom_fields.value string

De tekst van het aangepaste veld.

Plaatsing
invoice.custom_fields.placement string

De locatie van het aangepaste veld op de factuur.

Leveringsmethode
invoice.delivery_method string

De leveringsmethode die Square gebruikt om de factuur, herinneringen en ontvangstbewijzen naar de klant te verzenden. Nadat de factuur is gepubliceerd, verwerkt Square de factuur op basis van de instellingen voor de leveringswijze en betalingsaanvraag, direct of op de scheduled_at datum, indien opgegeven.

Verkoop- of servicedatum
invoice.sale_or_service_date string

De datum van de verkoop of de datum waarop de service wordt weergegeven, in JJJJ-MM-DD indeling. Dit veld kan worden gebruikt om een eerdere of toekomstige datum op te geven die op de factuur wordt weergegeven.

Factuur verwijderen

Hiermee verwijdert u de opgegeven factuur. Wanneer een factuur wordt verwijderd, wordt de bijbehorende orderstatus gewijzigd in GEANNULEERD. U kunt alleen een conceptfactuur verwijderen (u kunt een gepubliceerde factuur niet verwijderen, inclusief een factuur die is gepland voor verwerking).

Parameters

Name Sleutel Vereist Type Description
Factuur-id
invoice_id True string

De id van de factuur.

Versie
version integer

De te verwijderen versie van de factuur.

Retouren

response
object

Fysiek aantal inventaris ophalen

Retourneert het object InventoryPhysicalCount met de opgegeven physical_count_id.

Parameters

Name Sleutel Vereist Type Description
Id van fysiek aantal
physical_count_id True string

De id van het fysieke aantal.

Retouren

Name Pad Type Description
ID-kaart
count.id string

De unieke, door square uitgegeven id.

Referentie-id
count.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Catalogusobject-id
count.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobjecttype
count.catalog_object_type string

Het type CatalogObject dat wordt bijgehouden.

Staat
count.state string

De huidige status.

Locatie-id
count.location_id string

De id van de locatie.

Hoeveelheid
count.quantity string

Het aantal items dat wordt beïnvloed door de aanpassing als een decimale tekenreeks. Kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Product
count.source.product string

Producttype voor de toepassing.

Applicatie-ID
count.source.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Naam
count.source.name string

De naam.

Werknemer-id
count.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Opgetreden op
count.occurred_at string

Een door de client gegenereerde RFC 3339-geformatteerde tijdstempel die aangeeft wanneer de voorraadaanpassing heeft plaatsgevonden. Voor updates voor voorraadaanpassing mag de occurred_at tijdstempel niet ouder zijn dan 24 uur of in de toekomst ten opzichte van het tijdstip van de aanvraag.

Gemaakt op
count.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Geschil accepteren

Accepteert het verlies van een geschil. Square retourneert het betwiste bedrag aan de kaarthouder en werkt de status van het geschil bij naar GEACCEPTEERD. Square debiteert het betwiste bedrag van het vierkante account van de verkoper. Als de Square-rekening onvoldoende geld heeft, debiteert Square de bijbehorende bankrekening.

Parameters

Name Sleutel Vereist Type Description
Geschil-id
dispute_id True string

De id van het geschil.

Retouren

Name Pad Type Description
ID-kaart
dispute.id string

De unieke, door square uitgegeven id.

Aantal
dispute.amount_money.amount integer

Het bedrag.

Valuta
dispute.amount_money.currency string

De valuta.

Reden
dispute.reason string

De reden voor dit object.

Staat
dispute.state string

De huidige status.

Einddatum op
dispute.due_at string

Het tijdstip waarop de volgende actie moet worden uitgevoerd, in RFC 3339-indeling.

Betwiste betalingen
dispute.disputed_payments array of object
BetalingsID
dispute.disputed_payments.payment_id string

Door vierkanten gegenereerde unieke id van de betaling.

Merk kaart
dispute.card_brand string

Het merk van de kaart.

Gemaakt op
dispute.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
dispute.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Merkconflict-id
dispute.brand_dispute_id string

De id van het geschil in het merksysteem van de kaart, gegenereerd door het merk kaart.

Geschil ophalen

Retourneert details over een specifiek geschil.

Parameters

Name Sleutel Vereist Type Description
Geschil-id
dispute_id True string

De id van het geschil.

Retouren

Name Pad Type Description
ID-kaart
dispute.id string

De unieke, door square uitgegeven id.

Aantal
dispute.amount_money.amount integer

Het bedrag.

Valuta
dispute.amount_money.currency string

De valuta.

Reden
dispute.reason string

De reden voor dit object.

Staat
dispute.state string

De huidige status.

Einddatum op
dispute.due_at string

Het tijdstip waarop de volgende actie moet worden uitgevoerd, in RFC 3339-indeling.

Betwiste betalingen
dispute.disputed_payments array of object
BetalingsID
dispute.disputed_payments.payment_id string

Door vierkanten gegenereerde unieke id van de betaling.

Merk kaart
dispute.card_brand string

Het merk van de kaart.

Gemaakt op
dispute.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
dispute.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Merkconflict-id
dispute.brand_dispute_id string

De id van het geschil in het merksysteem van de kaart, gegenereerd door het merk kaart.

Geschilbewijs ophalen

Retourneert de metagegevens van het bewijs dat is opgegeven door de bewijs-id in het pad van de aanvraag-URL. U moet een kopie onderhouden van het bewijs dat u uploadt als u er later naar wilt verwijzen. U kunt het bewijs niet downloaden nadat u het hebt geüpload.

Parameters

Name Sleutel Vereist Type Description
Geschil-id
dispute_id True string

De id van het geschil.

Bewijs-id
evidence_id True string

De id van het bewijs.

Retouren

Name Pad Type Description
ID-kaart
evidence.id string

De unieke, door square uitgegeven id.

Geschil-id
evidence.dispute_id string

De id van het geschil is gekoppeld aan het bewijs.

Bestandsnaam
evidence.evidence_file.filename string

Bewijsbestanden voor geschillen moeten application/pdf, image/heic, image/heif, image/jpeg, image/png of image/tiff-indelingen zijn.

Bestandstype
evidence.evidence_file.filetype string

De bestandsnaam inclusief de bestandsextensie.

Bewijstype
evidence.evidence_type string

Het type pf-bewijs.

Geüpload op
evidence.uploaded_at string

Het tijdstip waarop de volgende actie moet worden uitgevoerd, in RFC 3339-indeling.

Geschilbewijs verwijderen

Hiermee verwijdert u opgegeven bewijs uit een geschil.

Parameters

Name Sleutel Vereist Type Description
Geschil-id
dispute_id True string

De id van het geschil.

Bewijs-id
evidence_id True string

De id van het bewijs.

Retouren

response
object

Geschillen vermelden

Retourneert een lijst met geschillen die zijn gekoppeld aan een bepaald account.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

States
states string

De geschilstatussen om het resultaat te filteren. Als dit niet is opgegeven, retourneert het eindpunt alle openstaande geschillen (de status van het geschil is niet INQUIRY_CLOSED, WON of LOST).

Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Retouren

Name Pad Type Description
Geschillen
disputes array of object
ID-kaart
disputes.id string

De unieke, door square uitgegeven id.

Aantal
disputes.amount_money.amount integer

Het bedrag.

Valuta
disputes.amount_money.currency string

De valuta.

Reden
disputes.reason string

De reden van het geschil waarom de kaarthouder het geschil met zijn bank heeft geïnitieerd.

Staat
disputes.state string

De huidige status.

Einddatum op
disputes.due_at string

Het tijdstip waarop de volgende actie moet worden uitgevoerd, in RFC 3339-indeling.

Betwiste betalingen
disputes.disputed_payments array of object
BetalingsID
disputes.disputed_payments.payment_id string

Door vierkanten gegenereerde unieke id van de betaling die wordt betwist.

Merk kaart
disputes.card_brand string

Het merk van de kaart dat in de betwiste betaling wordt gebruikt.

Gemaakt op
disputes.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
disputes.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Merkconflict-id
disputes.brand_dispute_id string

De id van het geschil in het merksysteem van de kaart, gegenereerd door het merk kaart.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Groep toevoegen aan klant

Voegt een groepslidmaatschap toe aan een klant. De klant wordt geïdentificeerd door de customer_id waarde en de klantgroep wordt geïdentificeerd door de group_id waarde.

Parameters

Name Sleutel Vereist Type Description
Klant-id
customer_id True string

De id van de klant.

Groeps-id
group_id True string

De id van de groep.

Retouren

response
object

Groep verwijderen van klant

Hiermee verwijdert u een groepslidmaatschap van een klant. De klant wordt geïdentificeerd door de customer_id waarde en de klantgroep wordt geïdentificeerd door de group_id waarde.

Parameters

Name Sleutel Vereist Type Description
Klant-id
customer_id True string

De id van de klant.

Groeps-id
group_id True string

De id van de groep.

Retouren

response
object

Inventarisaanpassing ophalen

Retourneert het object InventoryAdjustment met de opgegeven adjustment_id.

Parameters

Name Sleutel Vereist Type Description
Aanpassings-id
adjustment_id True string

De id van de aanpassing.

Retouren

Name Pad Type Description
ID-kaart
adjustment.id string

De unieke, door square uitgegeven id.

Referentie-id
adjustment.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Van staat
adjustment.from_state string

De inventarisstatus van de gerelateerde hoeveelheid artikelen vóór de aanpassing.

Naar status
adjustment.to_state string

De inventarisstatus van de gerelateerde hoeveelheid artikelen na de aanpassing.

Locatie-id
adjustment.location_id string

De id van de locatie.

Catalogusobject-id
adjustment.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobjecttype
adjustment.catalog_object_type string

Het type CatalogObject dat wordt bijgehouden.

Hoeveelheid
adjustment.quantity string

Het aantal items dat wordt beïnvloed door de aanpassing als een decimale tekenreeks. Kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Aantal
adjustment.total_price_money.amount integer

Het bedrag.

Valuta
adjustment.total_price_money.currency string

De valuta.

Opgetreden op
adjustment.occurred_at string

Een door de client gegenereerde RFC 3339-geformatteerde tijdstempel die aangeeft wanneer de voorraadaanpassing heeft plaatsgevonden. Voor updates voor voorraadaanpassing mag de occurred_at tijdstempel niet ouder zijn dan 24 uur of in de toekomst ten opzichte van het tijdstip van de aanvraag.

Gemaakt op
adjustment.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Product
adjustment.source.product string

Producttype voor de toepassing.

Applicatie-ID
adjustment.source.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Naam
adjustment.source.name string

De naam.

Werknemer-id
adjustment.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Inventarisoverdracht ophalen (bèta)

Retourneert het InventoryTransfer-object met de opgegeven transfer_id.

Parameters

Name Sleutel Vereist Type Description
Overdrachts-id
transfer_id True string

De id van de overdracht.

Retouren

Name Pad Type Description
ID-kaart
transfer.id string

De unieke, door square uitgegeven id.

Catalogusobject-id
transfer.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobjecttype
transfer.catalog_object_type string

Het type CatalogObject dat wordt bijgehouden.

Gemaakt op
transfer.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Werknemer-id
transfer.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Vanaf locatie-id
transfer.from_location_id string

De door het vierkant gegenereerde id van de locatie waar de gerelateerde hoeveelheid items vóór de overdracht is bijgehouden.

Locatie-id
transfer.to_location_id string

De door het vierkant gegenereerde id van de locatie waar de gerelateerde hoeveelheid items na de overdracht is bijgehouden.

Opgetreden op
transfer.occurred_at string

Een door de client gegenereerde RFC 3339-geformatteerde tijdstempel die aangeeft wanneer de voorraadaanpassing heeft plaatsgevonden. Voor updates voor voorraadaanpassing mag de occurred_at tijdstempel niet ouder zijn dan 24 uur of in de toekomst ten opzichte van het tijdstip van de aanvraag.

Hoeveelheid
transfer.quantity string

Het aantal items dat wordt beïnvloed door de aanpassing als een decimale tekenreeks. Kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Referentie-id
transfer.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Product
transfer.source.product string

Producttype voor de toepassing.

Applicatie-ID
transfer.source.application_id string

Alleen-lezen vierkante id die is toegewezen aan de toepassing.

Naam
transfer.source.name string

De naam.

Staat
transfer.state string

De huidige status.

Inventariswijzigingen in Batch ophalen

Retourneert historische fysieke tellingen en aanpassingen op basis van de opgegeven filtercriteria.

Parameters

Name Sleutel Vereist Type Description
Catalogusobject-id's
catalog_object_ids array of string
Locatie-id's
location_ids array of string
Types
types array of string
States
states array of string
Bijgewerkt na
updated_after string

Het filter om resultaten te retourneren met hun calculated_at waarde na de opgegeven tijd zoals opgegeven in een RFC 3339-tijdstempel.

Bijgewerkt vóór
updated_before string

Het filter om resultaten te retourneren met hun created_at of calculated_at waarde strikt vóór de opgegeven tijd zoals opgegeven in een RFC 3339-tijdstempel.

Retouren

Name Pad Type Description
Changes
changes array of object
Typologie
changes.type string

Het type van dit object.

ID-kaart
changes.physical_count.id string

De id van het object

Referentie-id
changes.physical_count.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id die deze kaart koppelt aan een andere entiteit in een extern systeem.

Catalogusobject-id
changes.physical_count.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobjecttype
changes.physical_count.catalog_object_type string

Het type CatalogObject dat wordt bijgehouden.

Staat
changes.physical_count.state string

De huidige voorraadstatus voor de gerelateerde hoeveelheid artikelen.

Locatie-id
changes.physical_count.location_id string

De locatie-id voor een ontvanger (anders dan de verkoper) die een deel van deze aanbesteding ontvangt.

Hoeveelheid
changes.physical_count.quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Product
changes.physical_count.source.product string

Producttype voor de toepassing.

Applicatie-ID
changes.physical_count.source.application_id string

Vierkante id die is toegewezen aan de toepassing.

Naam
changes.physical_count.source.name string

De naam van het item.

Werknemer-id
changes.physical_count.employee_id string

De door square gegenereerde id van de werknemer die verantwoordelijk is voor het fysieke aantal.

Opgetreden op
changes.physical_count.occurred_at string

Een door de client gegenereerde RFC 3339-geformatteerde tijdstempel die aangeeft wanneer het fysieke aantal is onderzocht. Voor updates voor fysieke aantallen mag de occurred_at tijdstempel niet ouder zijn dan 24 uur of in de toekomst ten opzichte van het tijdstip van de aanvraag.

Gemaakt op
changes.physical_count.created_at string

Een door de client gegenereerde RFC 3339-geformatteerde tijdstempel die aangeeft wanneer het fysieke aantal is gemaakt.

Itembelastingen bijwerken

Hiermee worden de CatalogTax-objecten bijgewerkt die van toepassing zijn op de beoogde CatalogItem zonder dat u een upsert hoeft uit te voeren op het hele item.

Parameters

Name Sleutel Vereist Type Description
Item-id's
item_ids array of string
Belastingen om in te schakelen
taxes_to_enable array of string
Belastingen om uit te schakelen
taxes_to_disable array of string

Retouren

Name Pad Type Description
Bijgewerkt op
updated_at string

De tijdstempel van de database van deze update in RFC 3339-indeling.

Kaart maken

Hiermee voegt u een kaart toe aan een bestaande verkoper.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

De idempotentiesleutel.

Bron-id
source_id string

De id van de bron.

Adresregel 1
address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
locality string

De stad of stad van het adres.

Administratief district niveau 1
administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
postal_code string

De postcode van het adres.

Country
country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Naam van kaarthouder
cardholder_name string

De naam van de kaarthouder.

Klant-id
customer_id string

De id van dit object die de klant vertegenwoordigt.

Referentie-id
reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Retouren

Name Pad Type Description
ID-kaart
card.id string

De unieke, door square uitgegeven id.

Adresregel 1
card.billing_address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
card.billing_address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
card.billing_address.locality string

De stad of stad van het adres.

Administratief district niveau 1
card.billing_address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
card.billing_address.postal_code string

De postcode van het adres.

Country
card.billing_address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Vingerafdruk
card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

VUILNISBAK
card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Merk kaart
card.card_brand string

Het merk van de kaart.

Kaarttype
card.card_type string

Het type kaart.

Naam van kaarthouder
card.cardholder_name string

De naam van de kaarthouder.

Klant-id
card.customer_id string

De id van dit object die de klant vertegenwoordigt.

Ingeschakeld
card.enabled boolean

Of dit is ingeschakeld.

Exp-maand
card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Laatste 4
card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Vooraf betaald type
card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

Referentie-id
card.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Versie
card.version integer

De huidige versie van dit object.

Kaart ophalen

Hiermee worden details opgehaald voor een specifieke kaart.

Parameters

Name Sleutel Vereist Type Description
Kaart-id
card_id True string

De id van de kaart.

Retouren

Name Pad Type Description
ID-kaart
card.id string

De unieke, door square uitgegeven id.

Adresregel 1
card.billing_address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
card.billing_address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
card.billing_address.locality string

De stad of stad van het adres.

Administratief district niveau 1
card.billing_address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
card.billing_address.postal_code string

De postcode van het adres.

Country
card.billing_address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Vingerafdruk
card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

VUILNISBAK
card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Merk kaart
card.card_brand string

Het merk van de kaart.

Kaarttype
card.card_type string

Het type kaart.

Naam van kaarthouder
card.cardholder_name string

De naam van de kaarthouder.

Klant-id
card.customer_id string

De id van dit object die de klant vertegenwoordigt.

Ingeschakeld
card.enabled boolean

Of dit is ingeschakeld.

Exp-maand
card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Laatste 4
card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Vooraf betaald type
card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

Referentie-id
card.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Versie
card.version integer

De huidige versie van dit object.

Kaart uitschakelen

Hiermee wordt de kaart uitgeschakeld, waardoor er geen verdere updates of kosten meer in rekening worden gebracht. Het uitschakelen van een al uitgeschakelde kaart is toegestaan, maar heeft geen effect.

Parameters

Name Sleutel Vereist Type Description
Kaart-id
card_id True string

De id van de kaart.

Retouren

Name Pad Type Description
ID-kaart
card.id string

De unieke, door square uitgegeven id.

Adresregel 1
card.billing_address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
card.billing_address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
card.billing_address.locality string

De stad of stad van het adres.

Administratief district niveau 1
card.billing_address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
card.billing_address.postal_code string

De postcode van het adres.

Country
card.billing_address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Vingerafdruk
card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

VUILNISBAK
card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Merk kaart
card.card_brand string

Het merk van de kaart.

Kaarttype
card.card_type string

Het type kaart.

Naam van kaarthouder
card.cardholder_name string

De naam van de kaarthouder.

Klant-id
card.customer_id string

De id van dit object die de klant vertegenwoordigt.

Ingeschakeld
card.enabled boolean

Of dit is ingeschakeld.

Exp-maand
card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Laatste 4
card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Vooraf betaald type
card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

Referentie-id
card.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Versie
card.version integer

De huidige versie van dit object.

Klant bijwerken

Hiermee werkt u een klantprofiel bij. Als u een kenmerk wilt wijzigen, geeft u de nieuwe waarde op. Als u een kenmerk wilt verwijderen, geeft u de waarde op als een lege tekenreeks of leeg object.

Parameters

Name Sleutel Vereist Type Description
Klant-id
customer_id True string

De id van de klant.

Retouren

Name Pad Type Description
ID-kaart
customer.id string

De unieke, door square uitgegeven id.

Gemaakt op
customer.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
customer.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Voornaam
customer.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
customer.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
customer.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Adresregel 1
customer.address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
customer.address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
customer.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
customer.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
customer.address.postal_code string

De postcode van het adres.

Country
customer.address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Referentie-id
customer.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Opmerking
customer.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

E-mail afgemeld
customer.preferences.email_unsubscribed boolean

Geeft aan of de klant zich heeft afgemeld voor marketingcampagne-e-mails. Een waarde van true betekent dat de klant ervoor heeft gekozen om zich af te wijzen voor e-mailmarketing van de huidige square verkoper of van alle square verkopers.

Bron maken
customer.creation_source string

Een bron voor maken vertegenwoordigt de methode die wordt gebruikt om het klantprofiel te maken.

Versie
customer.version integer

De huidige versie van dit object.

Klant maken

Hiermee maakt u een nieuwe klant voor een bedrijf.

Parameters

Name Sleutel Vereist Type Description
Voornaam
given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
family_name string

De familienaam (de achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Bedrijfsnaam
company_name string

Een bedrijfsnaam die is gekoppeld aan het klantprofiel.

Bijnaam
nickname string

Een bijnaam voor het klantprofiel.

Adresregel 1
address_line_1 string

De eerste regel van het adres.

Adresregel 2
address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
locality string

De stad of stad van het adres.

Administratief district niveau 1
administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
postal_code string

De postcode van het adres.

Country
country string

De ISO 3166 Alpha-2-landcode.

Telefoonnummer
phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Referentie-id
reference_id string

Een optionele tweede id die wordt gebruikt om het klantprofiel te koppelen aan een entiteit in een ander systeem.

Opmerking
note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Verjaardag
birthday string

De verjaardag die is gekoppeld aan het klantprofiel, in RFC 3339-indeling. Het jaar is optioneel. De tijdzone en tijd zijn niet toegestaan. Bijvoorbeeld: 0000-09-21T00:00:00-00:00 vertegenwoordigt een verjaardag op 21 september en 1998-09-21T00:00:00-00:00 een verjaardag op 21 september 1998. U kunt deze waarde ook opgeven in de indeling JJJJ-MM-DD.

Retouren

Name Pad Type Description
ID-kaart
customer.id string

De unieke, door square uitgegeven id.

Gemaakt op
customer.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
customer.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Voornaam
customer.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
customer.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
customer.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Bedrijfsnaam
customer.company_name string

Een bedrijfsnaam die is gekoppeld aan het klantprofiel.

Bijnaam
customer.nickname string

Een bijnaam voor het klantprofiel.

Adresregel 1
customer.address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
customer.address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
customer.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
customer.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
customer.address.postal_code string

De postcode van het adres.

Country
customer.address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Telefoonnummer
customer.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Referentie-id
customer.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Opmerking
customer.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Verjaardag
customer.birthday string

De verjaardag die is gekoppeld aan het klantprofiel, in RFC 3339-indeling. Het jaar is optioneel. De tijdzone en tijd zijn niet toegestaan. Bijvoorbeeld: 0000-09-21T00:00:00-00:00 vertegenwoordigt een verjaardag op 21 september en 1998-09-21T00:00:00-00:00 een verjaardag op 21 september 1998.

E-mail afgemeld
customer.preferences.email_unsubscribed boolean

Geeft aan of de klant zich heeft afgemeld voor marketingcampagne-e-mails. Een waarde van true betekent dat de klant ervoor heeft gekozen om zich af te wijzen voor e-mailmarketing van de huidige square verkoper of van alle square verkopers.

Bron maken
customer.creation_source string

Een bron voor maken vertegenwoordigt de methode die wordt gebruikt om het klantprofiel te maken.

Versie
customer.version integer

De huidige versie van dit object.

Klant ophalen

Retourneert details voor één klant.

Parameters

Name Sleutel Vereist Type Description
Klant-id
customer_id True string

De id van de klant.

Retouren

Name Pad Type Description
ID-kaart
customer.id string

De unieke, door square uitgegeven id.

Gemaakt op
customer.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
customer.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Voornaam
customer.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
customer.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
customer.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Adresregel 1
customer.address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
customer.address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
customer.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
customer.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
customer.address.postal_code string

De postcode van het adres.

Country
customer.address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Telefoonnummer
customer.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Referentie-id
customer.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Opmerking
customer.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

E-mail afgemeld
customer.preferences.email_unsubscribed boolean

Geeft aan of de klant zich heeft afgemeld voor marketingcampagne-e-mails. Een waarde van true betekent dat de klant ervoor heeft gekozen om zich af te wijzen voor e-mailmarketing van de huidige square verkoper of van alle square verkopers.

Bron maken
customer.creation_source string

Een bron voor maken vertegenwoordigt de methode die wordt gebruikt om het klantprofiel te maken.

Groeps-id's
customer.group_ids array of string
Segment-id's
customer.segment_ids array of string
Versie
customer.version integer

De huidige versie van dit object.

Klant verwijderen

Hiermee verwijdert u een klantprofiel uit een bedrijf. Met deze bewerking worden ook alle gekoppelde kaarten in het bestand ontkoppeld.

Parameters

Name Sleutel Vereist Type Description
Klant-id
customer_id True string

De id van de klant.

Retouren

response
object

Klanten vermelden

Toont klantprofielen die zijn gekoppeld aan een Square-account. Onder normale bedrijfsomstandigheden worden nieuw gemaakte of bijgewerkte klantprofielen binnen 30 seconden beschikbaar voor de vermeldingsbewerking. Af en toe kan het doorgeven van de nieuwe of bijgewerkte profielen dichter bij één minuut of langer duren, met name tijdens netwerkincidenten en storingen.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Sorteerveld
sort_field string

Geeft aan hoe klanten moeten worden gesorteerd. De standaardwaarde is STANDAARD.

Sorteervolgorde
sort_order string

Hiermee sorteert u de geretourneerde lijst op het moment dat de kaart is gemaakt met de opgegeven volgorde.

Retouren

Name Pad Type Description
Klanten
customers array of object
ID-kaart
customers.id string

De unieke, door square uitgegeven id.

Gemaakt op
customers.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
customers.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Voornaam
customers.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
customers.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
customers.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Adresregel 1
customers.address.address_line_1 string

De eerste regel van het adres.

Adresregel 2
customers.address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
customers.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
customers.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
customers.address.postal_code string

De postcode van het adres.

Country
customers.address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Telefoonnummer
customers.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Referentie-id
customers.reference_id string

Een optionele tweede id die wordt gebruikt om het klantprofiel te koppelen aan een entiteit in een ander systeem.

Opmerking
customers.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

E-mail afgemeld
customers.preferences.email_unsubscribed boolean

Geeft aan of de klant zich heeft afgemeld voor marketingcampagne-e-mails. Een waarde van true betekent dat de klant ervoor heeft gekozen om zich af te wijzen voor e-mailmarketing van de huidige square verkoper of van alle square verkopers. Deze waarde is alleen-lezen van de Klanten-API.

Bron maken
customers.creation_source string

Een bron voor maken vertegenwoordigt de methode die wordt gebruikt om het klantprofiel te maken.

Groeps-id's
customers.group_ids array of string
Segment-id's
customers.segment_ids array of string
Versie
customers.version integer

De huidige versie van het object.

Klanten zoeken

Hiermee doorzoekt u de klantprofielen die zijn gekoppeld aan een Vierkant-account met behulp van een ondersteund queryfilter. Als u SearchCustomers aanroept zonder een expliciet queryfilter, worden alle klantprofielen alfabetisch gesorteerd op basis van given_name en family_name geretourneerd.

Parameters

Name Sleutel Vereist Type Description
Mistig
fuzzy string

Gebruik het fuzzy filter om klanten te selecteren waarvan de kenmerken overeenkomen met de opgegeven query op een fuzzy manier. Wanneer de fuzzy optie wordt gebruikt, worden zoekquery's getokeniseerd en moet elke querytoken ergens in het doorzochte kenmerk worden vergeleken. Voor query's met één token is dit in feite hetzelfde gedrag als een gedeeltelijke overeenkomstbewerking.

Waarden
values array of string
Regel
rule string

Hiermee wordt aangegeven of een klantprofiel dat voldoet aan de filtercriteria, moet worden opgenomen in het resultaat of moet worden uitgesloten van het resultaat.

Beginnen bij
start_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik begint.

Eindigen op
end_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik eindigt.

All
all array of string
Veld
field string

Gebruik een of meer klantkenmerken als sorteersleutel om doorzochte klantprofielen te sorteren.

Bestelling
order string

Geeft de volgorde aan waarin de resultaten moeten worden gesorteerd op basis van de waarde van het sorteerveld. Tekenreeksen gebruiken standaard alfabetische vergelijking om de volgorde te bepalen.

Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Retouren

Name Pad Type Description
Klanten
customers array of object
ID-kaart
customers.id string

De unieke, door square uitgegeven id.

Gemaakt op
customers.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
customers.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Voornaam
customers.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
customers.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
customers.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Adresregel 1
customers.address.address_line_1 string

De eerste regel van het adres.

Adresregel 2
customers.address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
customers.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
customers.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
customers.address.postal_code string

De postcode van het adres.

Country
customers.address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Telefoonnummer
customers.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Referentie-id
customers.reference_id string

Een optionele tweede id die wordt gebruikt om het klantprofiel te koppelen aan een entiteit in een ander systeem.

E-mail afgemeld
customers.preferences.email_unsubscribed boolean

Geeft aan of de klant zich heeft afgemeld voor marketingcampagne-e-mails. Een waarde van true betekent dat de klant ervoor heeft gekozen om zich af te wijzen voor e-mailmarketing van de huidige square verkoper of van alle square verkopers. Deze waarde is alleen-lezen van de Klanten-API.

Bron maken
customers.creation_source string

Een bron voor maken vertegenwoordigt de methode die wordt gebruikt om het klantprofiel te maken.

Groeps-id's
customers.group_ids array of string
Segment-id's
customers.segment_ids array of string
Versie
customers.version integer

De huidige versie van het object.

Opmerking
customers.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Klantgroep bijwerken

Hiermee werkt u een klantgroep bij.

Parameters

Name Sleutel Vereist Type Description
Groeps-id
group_id True string

De id van de groep.

Naam
name string

De naam van het object.

Retouren

Name Pad Type Description
ID-kaart
group.id string

De unieke, door square uitgegeven id.

Naam
group.name string

De naam van het object.

Gemaakt op
group.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
group.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klantgroep maken

Hiermee maakt u een nieuwe klantgroep voor een bedrijf.

Parameters

Name Sleutel Vereist Type Description
Naam
name string

De naam van het object.

Retouren

Name Pad Type Description
ID-kaart
group.id string

De unieke, door square uitgegeven id.

Naam
group.name string

De naam van het object.

Gemaakt op
group.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
group.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klantgroep ophalen

Hiermee haalt u een specifieke klantgroep op.

Parameters

Name Sleutel Vereist Type Description
Groeps-id
group_id True string

De id van de groep.

Retouren

Name Pad Type Description
ID-kaart
group.id string

De unieke, door square uitgegeven id.

Naam
group.name string

De naam van het object.

Gemaakt op
group.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
group.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klantgroep verwijderen

Hiermee verwijdert u een klantgroep zoals aangegeven door de group_id waarde.

Parameters

Name Sleutel Vereist Type Description
Groeps-id
group_id True string

De id van de groep.

Retouren

response
object

Klantgroepen weergeven

Haalt de lijst met klantgroepen van een bedrijf op.

Retouren

Name Pad Type Description
Groups
groups array of object
ID-kaart
groups.id string

De unieke, door square uitgegeven id.

Naam
groups.name string

De naam van het object.

Gemaakt op
groups.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
groups.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Klantsegment ophalen

Hiermee haalt u een specifiek klantsegment op.

Parameters

Name Sleutel Vereist Type Description
Segment-id
segment_id True string

De id van het segment.

Retouren

Name Pad Type Description
ID-kaart
segment.id string

De unieke, door square uitgegeven id.

Naam
segment.name string

De naam van het object.

Gemaakt op
segment.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
segment.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Klantsegmenten vermelden

Haalt de lijst met klantsegmenten van een bedrijf op.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Retouren

Name Pad Type Description
Segmenten
segments array of object
ID-kaart
segments.id string

De unieke, door square uitgegeven id.

Naam
segments.name string

De naam van het object.

Gemaakt op
segments.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
segments.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Lijstcatalogus

Retourneert een lijst met CatalogObjects met alle objecten van een set gewenste typen (bijvoorbeeld alle CatalogItem- en CatalogTax-objecten) in de catalogus. ListCatalog retourneert geen verwijderde catalogusitems.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor integer

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Types
types string

Een optionele niet-hoofdlettergevoelige, door komma's gescheiden lijst met objecttypen die moeten worden opgehaald. De geldige waarden worden gedefinieerd in de enum CatalogObjectType, waaronder ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST of IMAGE. Als dit niet is opgegeven, retourneert de bewerking objecten van alle typen in de versie van de Square-API die wordt gebruikt om de aanvraag te doen.

Retouren

Name Pad Type Description
Objects
objects array of object
Typologie
objects.type string

Het type van dit object.

ID-kaart
objects.id string

De unieke, door square uitgegeven id.

Bijgewerkt op
objects.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Versie
objects.version integer

De huidige versie van het object.

Wordt verwijderd
objects.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
objects.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
objects.category_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Naam
objects.tax_data.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Berekeningsfase
objects.tax_data.calculation_phase string

Of de belasting wordt berekend op basis van het subtotaal of het totaal van een betaling.

Insluitingstype
objects.tax_data.inclusion_type string

Of de belasting ADDITIEF of INCLUSIEF is.

Procent
objects.tax_data.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Ingeschakeld
objects.tax_data.enabled boolean

Hiermee wordt aangegeven of een object al dan niet kan worden gebruikt.

Lijstkaarten

Hiermee haalt u een lijst op met kaarten die eigendom zijn van het account dat de aanvraag indient.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Klant-id
customer_id string

Beperk de resultaten tot kaarten die zijn gekoppeld aan de door de klant opgegeven. Standaard worden alle kaarten die eigendom zijn van de verkoper geretourneerd.

Opnemen uitgeschakeld
include_disabled boolean

Inclusief uitgeschakelde kaarten. Standaard worden alle ingeschakelde kaarten geretourneerd die eigendom zijn van de verkoper.

Referentie-id
reference_id string

Beperk de resultaten tot kaarten die zijn gekoppeld aan de opgegeven reference_id.

Sorteervolgorde
sort_order string

Hiermee sorteert u de geretourneerde lijst op het moment dat de kaart is gemaakt met de opgegeven volgorde.

Retouren

Name Pad Type Description
Cards
cards array of object
ID-kaart
cards.card.id string

De id van het object

Adresregel 1
cards.card.billing_address.address_line_1 string

Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
cards.card.billing_address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
cards.card.billing_address.locality string

De stad of stad van het adres.

Administratief district niveau 1
cards.card.billing_address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
cards.card.billing_address.postal_code string

De postcode van het adres.

Country
cards.card.billing_address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Vingerafdruk
cards.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

VUILNISBAK
cards.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Merk kaart
cards.card.card_brand string

Het merk van de kaart.

Kaarttype
cards.card.card_type string

Het type kaart.

Naam van kaarthouder
cards.card.cardholder_name string

De naam van de kaarthouder.

Klant-id
cards.card.customer_id string

De id van een klant die aan de kaart moet worden gekoppeld.

Ingeschakeld
cards.card.enabled boolean

Hiermee wordt aangegeven of een object al dan niet kan worden gebruikt.

Verloopmaand
cards.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Verloopjaar
cards.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Laatste 4
cards.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Vooraf betaald type
cards.card.prepaid_type string

Geeft aan of de kaart vooruitbetaald is of niet.

Referentie-id
cards.card.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id die deze kaart koppelt aan een andere entiteit in een extern systeem.

Versie
cards.card.version integer

Huidig versienummer van de kaart. Wordt verhoogd met elke kaartupdate. Aanvragen voor het bijwerken van een bestaand kaartobject worden geweigerd, tenzij de versie in de aanvraag overeenkomt met de huidige versie voor de kaart.

Order berekenen (bèta)

Hiermee kunnen toepassingen preview-prijzen voor bestellingen bekijken zonder een order te maken.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Locatie-id
location_id string

De id van de locatie.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Procent
percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Scope
scope string

Geeft het huidige niveau aan.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Hoeveelheid
quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Retouren

Name Pad Type Description
Locatie-id
order.location_id string

De id van de locatie.

Regelitems
order.line_items array of object
UID
order.line_items.uid string

De door het vierkant gegenereerde id.

Hoeveelheid
order.line_items.quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Naam
order.line_items.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Aantal
order.line_items.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.base_price_money.currency string

De valuta.

Aantal
order.line_items.gross_sales_money.amount integer

Het bedrag.

Valuta
order.line_items.gross_sales_money.currency string

De valuta.

Aantal
order.line_items.total_tax_money.amount integer

Het bedrag.

Valuta
order.line_items.total_tax_money.currency string

De valuta.

Aantal
order.line_items.total_discount_money.amount integer

Het bedrag.

Valuta
order.line_items.total_discount_money.currency string

De valuta.

Aantal
order.line_items.total_money.amount integer

Het bedrag.

Valuta
order.line_items.total_money.currency string

De valuta.

Aantal
order.line_items.variation_total_price_money.amount integer

Het bedrag.

Valuta
order.line_items.variation_total_price_money.currency string

De valuta.

Toegepaste kortingen
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Een door een vierkant toegewezen id.

Kortings-UID
order.line_items.applied_discounts.discount_uid string

De uid van de korting die de toegepaste korting vertegenwoordigt.

Aantal
order.line_items.applied_discounts.applied_money.amount integer

Het bedrag.

Valuta
order.line_items.applied_discounts.applied_money.currency string

De valuta.

Kortingen
order.discounts array of object
UID
order.discounts.uid string

De door het vierkant gegenereerde id.

Naam
order.discounts.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Procent
order.discounts.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Aantal
order.discounts.applied_money.amount integer

Het bedrag.

Valuta
order.discounts.applied_money.currency string

De valuta.

Typologie
order.discounts.type string

Geeft het type aan.

Scope
order.discounts.scope string

Geeft het huidige niveau aan.

Gemaakt op
order.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
order.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Staat
order.state string

De huidige status.

Versie
order.version integer

De huidige versie van dit object.

Aantal
order.total_tax_money.amount integer

Het bedrag.

Valuta
order.total_tax_money.currency string

De valuta.

Aantal
order.total_discount_money.amount integer

Het bedrag.

Valuta
order.total_discount_money.currency string

De valuta.

Aantal
order.total_tip_money.amount integer

Het bedrag.

Valuta
order.total_tip_money.currency string

De valuta.

Aantal
order.total_money.amount integer

Het bedrag.

Valuta
order.total_money.currency string

De valuta.

Aantal
order.total_service_charge_money.amount integer

Het bedrag.

Valuta
order.total_service_charge_money.currency string

De valuta.

Aantal
order.net_amounts.total_money.amount integer

Het bedrag.

Valuta
order.net_amounts.total_money.currency string

De valuta.

Aantal
order.net_amounts.tax_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tax_money.currency string

De valuta.

Aantal
order.net_amounts.discount_money.amount integer

Het bedrag.

Valuta
order.net_amounts.discount_money.currency string

De valuta.

Aantal
order.net_amounts.tip_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tip_money.currency string

De valuta.

Aantal
order.net_amounts.service_charge_money.amount integer

Het bedrag.

Valuta
order.net_amounts.service_charge_money.currency string

De valuta.

Order maken

Hiermee maakt u een nieuwe bestelling die informatie kan bevatten over producten voor aankoop en instellingen die van toepassing zijn op de aankoop.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Referentie-id
reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Locatie-id
location_id string

De id van de locatie.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Hoeveelheid
quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Catalogusobject-id
catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobject-id
catalog_object_id string

De object-id van de catalogus.

Kortings-UID
discount_uid string

De uid van de korting die de toegepaste korting vertegenwoordigt.

UID
uid string

De door het vierkant gegenereerde id.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Procent
percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Scope
scope string

Geeft het huidige niveau aan.

UID
uid string

De door het vierkant gegenereerde id.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Procent
percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Scope
scope string

Geeft het huidige niveau aan.

Catalogusobject-id
catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Retouren

Name Pad Type Description
ID-kaart
order.id string

De unieke, door square uitgegeven id.

Locatie-id
order.location_id string

De id van de locatie.

Regelitems
order.line_items array of object
UID
order.line_items.uid string

De door het vierkant gegenereerde id.

Naam
order.line_items.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Hoeveelheid
order.line_items.quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Toegepaste belastingen
order.line_items.applied_taxes array of object
UID
order.line_items.applied_taxes.uid string

Een door een vierkant toegewezen id.

Btw-UID
order.line_items.applied_taxes.tax_uid string

De UID van de belasting waarvoor deze toegepaste belasting staat.

Aantal
order.line_items.applied_taxes.applied_money.amount integer

Het bedrag.

Valuta
order.line_items.applied_taxes.applied_money.currency string

De valuta.

Toegepaste kortingen
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Een door een vierkant toegewezen id.

Kortings-UID
order.line_items.applied_discounts.discount_uid string

De uid van de korting die de toegepaste korting vertegenwoordigt.

Aantal
order.line_items.applied_discounts.applied_money.amount integer

Het bedrag.

Valuta
order.line_items.applied_discounts.applied_money.currency string

De valuta.

Aantal
order.line_items.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.base_price_money.currency string

De valuta.

Aantal
order.line_items.gross_sales_money.amount integer

Het bedrag.

Valuta
order.line_items.gross_sales_money.currency string

De valuta.

Aantal
order.line_items.total_tax_money.amount integer

Het bedrag.

Valuta
order.line_items.total_tax_money.currency string

De valuta.

Aantal
order.line_items.total_discount_money.amount integer

Het bedrag.

Valuta
order.line_items.total_discount_money.currency string

De valuta.

Aantal
order.line_items.total_money.amount integer

Het bedrag.

Valuta
order.line_items.total_money.currency string

De valuta.

Aantal
order.line_items.variation_total_price_money.amount integer

Het bedrag.

Valuta
order.line_items.variation_total_price_money.currency string

De valuta.

Catalogusobject-id
order.line_items.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Variatienaam
order.line_items.variation_name string

De naam van de variatie die op dit regelitem is toegepast.

Modificatoren
order.line_items.modifiers array of object
UID
order.line_items.modifiers.uid string

Een door een vierkant toegewezen id.

Catalogusobject-id
order.line_items.modifiers.catalog_object_id string

De object-id van de catalogus.

Naam
order.line_items.modifiers.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Aantal
order.line_items.modifiers.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.modifiers.base_price_money.currency string

De valuta.

Aantal
order.line_items.modifiers.total_price_money.amount integer

Het bedrag.

Valuta
order.line_items.modifiers.total_price_money.currency string

De valuta.

Belastingen
order.taxes array of object
UID
order.taxes.uid string

De door het vierkant gegenereerde id.

Naam
order.taxes.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Typologie
order.taxes.type string

Geeft het type aan.

Procent
order.taxes.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Aantal
order.taxes.applied_money.amount integer

Het bedrag.

Valuta
order.taxes.applied_money.currency string

De valuta.

Scope
order.taxes.scope string

Geeft het huidige niveau aan.

Kortingen
order.discounts array of object
UID
order.discounts.uid string

De door het vierkant gegenereerde id.

Catalogusobject-id
order.discounts.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Naam
order.discounts.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Typologie
order.discounts.type string

Geeft het type aan.

Procent
order.discounts.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Aantal
order.discounts.applied_money.amount integer

Het bedrag.

Valuta
order.discounts.applied_money.currency string

De valuta.

Scope
order.discounts.scope string

Geeft het huidige niveau aan.

Aantal
order.discounts.amount_money.amount integer

Het bedrag.

Valuta
order.discounts.amount_money.currency string

De valuta.

Gemaakt op
order.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
order.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Staat
order.state string

De huidige status.

Versie
order.version integer

De huidige versie van dit object.

Referentie-id
order.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Aantal
order.total_money.amount integer

Het bedrag.

Valuta
order.total_money.currency string

De valuta.

Aantal
order.total_tax_money.amount integer

Het bedrag.

Valuta
order.total_tax_money.currency string

De valuta.

Aantal
order.total_discount_money.amount integer

Het bedrag.

Valuta
order.total_discount_money.currency string

De valuta.

Aantal
order.total_tip_money.amount integer

Het bedrag.

Valuta
order.total_tip_money.currency string

De valuta.

Aantal
order.total_service_charge_money.amount integer

Het bedrag.

Valuta
order.total_service_charge_money.currency string

De valuta.

Aantal
order.net_amounts.total_money.amount integer

Het bedrag.

Valuta
order.net_amounts.total_money.currency string

De valuta.

Aantal
order.net_amounts.tax_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tax_money.currency string

De valuta.

Aantal
order.net_amounts.discount_money.amount integer

Het bedrag.

Valuta
order.net_amounts.discount_money.currency string

De valuta.

Aantal
order.net_amounts.tip_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tip_money.currency string

De valuta.

Aantal
order.net_amounts.service_charge_money.amount integer

Het bedrag.

Valuta
order.net_amounts.service_charge_money.currency string

De valuta.

Naam
order.source.name string

De naam.

Order ophalen

Hiermee haalt u een order op id op.

Parameters

Name Sleutel Vereist Type Description
Order-id
order_id True string

De id van de order.

Retouren

Name Pad Type Description
ID-kaart
order.id string

De unieke, door square uitgegeven id.

Locatie-id
order.location_id string

De id van de locatie.

Regelitems
order.line_items array of object
UID
order.line_items.uid string

De door het vierkant gegenereerde id.

Hoeveelheid
order.line_items.quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Naam
order.line_items.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Aantal
order.line_items.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.base_price_money.currency string

De valuta.

Aantal
order.line_items.gross_sales_money.amount integer

Het bedrag.

Valuta
order.line_items.gross_sales_money.currency string

De valuta.

Aantal
order.line_items.total_tax_money.amount integer

Het bedrag.

Valuta
order.line_items.total_tax_money.currency string

De valuta.

Aantal
order.line_items.total_discount_money.amount integer

Het bedrag.

Valuta
order.line_items.total_discount_money.currency string

De valuta.

Aantal
order.line_items.total_money.amount integer

Het bedrag.

Valuta
order.line_items.total_money.currency string

De valuta.

Aantal
order.line_items.variation_total_price_money.amount integer

Het bedrag.

Valuta
order.line_items.variation_total_price_money.currency string

De valuta.

Toegepaste kortingen
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Een door een vierkant toegewezen id.

Kortings-UID
order.line_items.applied_discounts.discount_uid string

De uid van de korting die de toegepaste korting vertegenwoordigt.

Aantal
order.line_items.applied_discounts.applied_money.amount integer

Het bedrag.

Valuta
order.line_items.applied_discounts.applied_money.currency string

De valuta.

Kortingen
order.discounts array of object
UID
order.discounts.uid string

De door het vierkant gegenereerde id.

Naam
order.discounts.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Procent
order.discounts.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Aantal
order.discounts.applied_money.amount integer

Het bedrag.

Valuta
order.discounts.applied_money.currency string

De valuta.

Typologie
order.discounts.type string

Geeft het type aan.

Scope
order.discounts.scope string

Geeft het huidige niveau aan.

Gemaakt op
order.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
order.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Staat
order.state string

De huidige status.

Versie
order.version integer

De huidige versie van dit object.

Aantal
order.total_tax_money.amount integer

Het bedrag.

Valuta
order.total_tax_money.currency string

De valuta.

Aantal
order.total_discount_money.amount integer

Het bedrag.

Valuta
order.total_discount_money.currency string

De valuta.

Aantal
order.total_tip_money.amount integer

Het bedrag.

Valuta
order.total_tip_money.currency string

De valuta.

Aantal
order.total_money.amount integer

Het bedrag.

Valuta
order.total_money.currency string

De valuta.

Aantal
order.total_service_charge_money.amount integer

Het bedrag.

Valuta
order.total_service_charge_money.currency string

De valuta.

Aantal
order.net_amounts.total_money.amount integer

Het bedrag.

Valuta
order.net_amounts.total_money.currency string

De valuta.

Aantal
order.net_amounts.tax_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tax_money.currency string

De valuta.

Aantal
order.net_amounts.discount_money.amount integer

Het bedrag.

Valuta
order.net_amounts.discount_money.currency string

De valuta.

Aantal
order.net_amounts.tip_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tip_money.currency string

De valuta.

Aantal
order.net_amounts.service_charge_money.amount integer

Het bedrag.

Valuta
order.net_amounts.service_charge_money.currency string

De valuta.

Restitutiebetaling

Terugbetaling van een betaling. U kunt het volledige betalingsbedrag of een deel ervan terugbetalen. U kunt dit eindpunt gebruiken om een creditcardbetaling te terugbetalen of een restitutie van een contante of externe betaling vast te leggen.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

BetalingsID
payment_id string

De unieke id van de betaling die wordt terugbetaald.

Aantal
amount integer

Het bedrag dat moet worden geaccepteerd voor deze betaling, niet inclusief tip_money.

Valuta
currency string

De ISO 4217-valutacode van 3 tekens.

Aantal
amount integer

Het bedrag dat moet worden geaccepteerd voor deze betaling, niet inclusief tip_money.

Valuta
currency string

De ISO 4217-valutacode van 3 tekens.

Reden
reason string

Een beschrijving van de reden voor de restitutie.

Retouren

Name Pad Type Description
ID-kaart
refund.id string

De unieke, door square uitgegeven id.

Toestand
refund.status string

De huidige verificatiestatus van dit object.

Aantal
refund.amount_money.amount integer

Het bedrag.

Valuta
refund.amount_money.currency string

De valuta.

BetalingsID
refund.payment_id string

De unieke id van de betaling.

Order-id
refund.order_id string

De id van de order.

Gemaakt op
refund.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
refund.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Aantal
refund.app_fee_money.amount integer

Het bedrag.

Valuta
refund.app_fee_money.currency string

De valuta.

Locatie-id
refund.location_id string

De id van de locatie.

Reden
refund.reason string

De reden voor dit object.

Tekst voor geschilbewijs maken

Hiermee uploadt u tekst die moet worden gebruikt als bewijs voor een geschilvraag.

Parameters

Name Sleutel Vereist Type Description
Geschil-id
dispute_id True string

De id van het geschil.

Bewijstype
evidence_type string

Het type bewijs dat u uploadt.

Tekst van bewijs
evidence_text string

De bewijsreeks.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

Name Pad Type Description
ID-kaart
evidence.id string

De unieke, door square uitgegeven id.

Geschil-id
evidence.dispute_id string

De id van het geschil is gekoppeld aan het bewijs.

Tekst van bewijs
evidence.evidence_text string

De onbewerkte tekst.

Bewijstype
evidence.evidence_type string

Het type pf-bewijs.

Geüpload op
evidence.uploaded_at string

Het tijdstip waarop de volgende actie moet worden uitgevoerd, in RFC 3339-indeling.

Terminal uitchecken annuleren

Hiermee annuleert u een Terminal-betalingsaanvraag als de status van de aanvraag dit toestaat.

Parameters

Name Sleutel Vereist Type Description
Betaal-id
checkout_id True string

De id van de betaling.

Retouren

Name Pad Type Description
ID-kaart
checkout.id string

De unieke, door square uitgegeven id.

Aantal
checkout.amount_money.amount integer

Het bedrag.

Valuta
checkout.amount_money.currency string

De valuta.

Referentie-id
checkout.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Apparaat-id
checkout.device_options.device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalCheckout.

Tipping toestaan
checkout.device_options.tip_settings.allow_tipping boolean

Geeft aan of tipping is ingeschakeld voor deze betaling. Standaard ingesteld op onwaar.

Ontvangstbewijsscherm overslaan
checkout.device_options.skip_receipt_screen boolean

Hiermee geeft u het apparaat de opdracht om het ontvangstscherm over te slaan. Standaard ingesteld op onwaar.

Toestand
checkout.status string

De huidige verificatiestatus van dit object.

Reden annuleren
checkout.cancel_reason string

De reden voor de geannuleerde transactie.

Gemaakt op
checkout.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
checkout.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

App-id
checkout.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Deadlineduur
checkout.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Terminal uitchecken maken

Hiermee maakt u een Terminal-betaalaanvraag en verzendt u deze naar het opgegeven apparaat om een betaling voor het aangevraagde bedrag te doen.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Referentie-id
reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Apparaat-id
device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalCheckout.

Opmerking
note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Retouren

Name Pad Type Description
ID-kaart
checkout.id string

De unieke, door square uitgegeven id.

Aantal
checkout.amount_money.amount integer

Het bedrag.

Valuta
checkout.amount_money.currency string

De valuta.

Referentie-id
checkout.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Opmerking
checkout.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Apparaat-id
checkout.device_options.device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalCheckout.

Tipping toestaan
checkout.device_options.tip_settings.allow_tipping boolean

Geeft aan of tipping is ingeschakeld voor deze betaling. Standaard ingesteld op onwaar.

Ontvangstbewijsscherm overslaan
checkout.device_options.skip_receipt_screen boolean

Hiermee geeft u het apparaat de opdracht om het ontvangstscherm over te slaan. Standaard ingesteld op onwaar.

Toestand
checkout.status string

De huidige verificatiestatus van dit object.

Gemaakt op
checkout.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
checkout.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

App-id
checkout.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Deadlineduur
checkout.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Betalingstype
checkout.payment_type string

Het type betaling waaruit de terminal moet proberen vast te leggen. Standaard ingesteld op CARD_PRESENT.

Terminal uitchecken ophalen

Hiermee haalt u een Terminal-betaalaanvraag op door checkout_id.

Parameters

Name Sleutel Vereist Type Description
Betaal-id
checkout_id True string

De id van de betaling.

Retouren

Name Pad Type Description
ID-kaart
checkout.id string

De unieke, door square uitgegeven id.

Aantal
checkout.amount_money.amount integer

Het bedrag.

Valuta
checkout.amount_money.currency string

De valuta.

Referentie-id
checkout.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Opmerking
checkout.note string

Een aangepaste notitie die is gekoppeld aan het klantprofiel.

Apparaat-id
checkout.device_options.device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalCheckout.

Tipping toestaan
checkout.device_options.tip_settings.allow_tipping boolean

Geeft aan of tipping is ingeschakeld voor deze betaling. Standaard ingesteld op onwaar.

Ontvangstbewijsscherm overslaan
checkout.device_options.skip_receipt_screen boolean

Hiermee geeft u het apparaat de opdracht om het ontvangstscherm over te slaan. Standaard ingesteld op onwaar.

Toestand
checkout.status string

De huidige verificatiestatus van dit object.

Gemaakt op
checkout.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
checkout.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

App-id
checkout.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Deadlineduur
checkout.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Terminalrestitutie aanvragen

Hiermee wordt een Interac Terminal-restitutieobject opgehaald op basis van id.

Parameters

Name Sleutel Vereist Type Description
Terminal restitutie-id
terminal_refund_id True string

De id van de terminalrestitutie.

Retouren

Name Pad Type Description
ID-kaart
refund.id string

De unieke, door square uitgegeven id.

Restitutie-id
refund.refund_id string

De unieke id voor deze restitutie, gegenereerd door Square.

BetalingsID
refund.payment_id string

De unieke id van de betaling.

Aantal
refund.amount_money.amount integer

Het bedrag.

Valuta
refund.amount_money.currency string

De valuta.

Reden
refund.reason string

De reden voor dit object.

Apparaat-id
refund.device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalRefund.

Deadlineduur
refund.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Toestand
refund.status string

De huidige verificatiestatus van dit object.

Gemaakt op
refund.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
refund.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

App-id
refund.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Merk kaart
refund.card.card_brand string

Het merk van de kaart.

last_4
refund.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
refund.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
refund.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
refund.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
refund.card.card_type string

Het type kaart.

VUILNISBAK
refund.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Order-id
refund.order_id string

De id van de order.

Locatie-id
refund.location_id string

De id van de locatie.

Terminalrestitutie annuleren

Hiermee annuleert u een Interac Terminal-restitutieaanvraag op restitutieaanvraag-id als de status van de aanvraag dit toestaat.

Parameters

Name Sleutel Vereist Type Description
Terminal restitutie-id
terminal_refund_id True string

De id van de terminalrestitutie.

Retouren

Name Pad Type Description
ID-kaart
refund.id string

De unieke, door square uitgegeven id.

BetalingsID
refund.payment_id string

De unieke id van de betaling.

Aantal
refund.amount_money.amount integer

Het bedrag.

Valuta
refund.amount_money.currency string

De valuta.

Reden
refund.reason string

De reden voor dit object.

Apparaat-id
refund.device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalRefund.

Deadlineduur
refund.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Toestand
refund.status string

De huidige verificatiestatus van dit object.

Reden annuleren
refund.cancel_reason string

De reden voor de geannuleerde transactie.

Gemaakt op
refund.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
refund.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

App-id
refund.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Merk kaart
refund.card.card_brand string

Het merk van de kaart.

last_4
refund.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
refund.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
refund.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
refund.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
refund.card.card_type string

Het type kaart.

VUILNISBAK
refund.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Order-id
refund.order_id string

De id van de order.

Locatie-id
refund.location_id string

De id van de locatie.

Terminalrestitutie maken

Hiermee maakt u een aanvraag voor het terugbetalen van een Interac-betaling die is voltooid op een Square Terminal.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Apparaat-id
device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalRefund.

Reden
reason string

De reden voor dit object.

BetalingsID
payment_id string

De unieke id van de betaling.

Retouren

Name Pad Type Description
ID-kaart
refund.id string

De unieke, door square uitgegeven id.

BetalingsID
refund.payment_id string

De unieke id van de betaling.

Aantal
refund.amount_money.amount integer

Het bedrag.

Valuta
refund.amount_money.currency string

De valuta.

Reden
refund.reason string

De reden voor dit object.

Apparaat-id
refund.device_id string

De unieke id van het apparaat dat is bedoeld voor deze TerminalRefund.

Deadlineduur
refund.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Toestand
refund.status string

De huidige verificatiestatus van dit object.

Gemaakt op
refund.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
refund.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

App-id
refund.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Merk kaart
refund.card.card_brand string

Het merk van de kaart.

last_4
refund.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Exp-maand
refund.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Exp-jaar
refund.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
refund.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
refund.card.card_type string

Het type kaart.

VUILNISBAK
refund.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Order-id
refund.order_id string

De id van de order.

Locatie-id
refund.location_id string

De id van de locatie.

Terminalrestituties zoeken

Hiermee haalt u een gefilterde lijst met aanvragen voor terugbetaling van Interac Terminal op die zijn gemaakt door de verkoper die de aanvraag indient.

Parameters

Name Sleutel Vereist Type Description
Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Toestand
status string

De huidige status.

Retouren

Name Pad Type Description
Restituties
refunds array of object
ID-kaart
refunds.id string

De unieke, door square uitgegeven id.

Restitutie-id
refunds.refund_id string

De unieke id voor deze restitutie, gegenereerd door Square.

BetalingsID
refunds.payment_id string

De id van de betaling.

Aantal
refunds.amount_money.amount integer

Het bedrag.

Valuta
refunds.amount_money.currency string

De valuta.

Reden
refunds.reason string

De reden van het geschil waarom de kaarthouder het geschil met zijn bank heeft geïnitieerd.

Apparaat-id
refunds.device_id string

De unieke id van het apparaat dat deze code heeft gebruikt. Wordt ingevuld wanneer het apparaat is gekoppeld.

Deadlineduur
refunds.deadline_duration string

Een RFC 3339-duur, waarna de betaling automatisch wordt geannuleerd. Een TerminalCheckout die IN BEHANDELING is, wordt automatisch GEANNULEERD en heeft een annuleringsreden van TIMED_OUT. Standaard: 5 minuten na het maken

Toestand
refunds.status string

De huidige verificatiestatus van dit object.

Gemaakt op
refunds.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
refunds.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

App-id
refunds.app_id string

De id van de toepassing die de betaling heeft gemaakt.

Merk kaart
refunds.card.card_brand string

Het merk van de kaart.

Laatste 4
refunds.card.last_4 string

De laatste 4 cijfers van het kaartnummer.

Verloopmaand
refunds.card.exp_month integer

De vervaldatummaand van de gekoppelde kaart als een geheel getal tussen 1 en 12.

Verloopjaar
refunds.card.exp_year integer

Het viercijferige jaar van de vervaldatum van de kaart.

Vingerafdruk
refunds.card.fingerprint string

Bedoeld als een door square toegewezen id, op basis van het kaartnummer, om de kaart te identificeren op meerdere locaties binnen één toepassing.

Kaarttype
refunds.card.card_type string

Het type kaart.

VUILNISBAK
refunds.card.bin string

De eerste zes cijfers van het kaartnummer, bekend als het bankidentificatienummer (BIN).

Order-id
refunds.order_id string

De id van de order.

Locatie-id
refunds.location_id string

De id voor de locatie.

Upsert-catalogusobject

Hiermee maakt of werkt u het doelObject CatalogObject bij.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

ID-kaart
id string

De unieke, door square uitgegeven id.

Typologie
type string

Het type van dit object.

Abbreviation
abbreviation string

De tekst van het weergavelabel van het item in de app Square Point of Sale. Alleen de eerste vijf tekens van de tekenreeks worden gebruikt. Dit kenmerk kan worden doorzocht en de waardelengte is van Unicode-codepunten.

Description
title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Naam
name string

De naam.

ID-kaart
id string

Een id die naar dit object in de catalogus verwijst.

Typologie
type string

Het type van dit object.

Item-id
item_id string

De id van de CatalogItem die is gekoppeld aan deze itemvariatie.

Naam
name string

De naam van de itemvariatie. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Prijstype
pricing_type string

Hiermee wordt aangegeven of de prijs van de artikelvariatie is vast of bepaald op het moment van verkoop.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Retouren

Name Pad Type Description
Typologie
catalog_object.type string

Het type van dit object.

ID-kaart
catalog_object.id string

De unieke, door square uitgegeven id.

Bijgewerkt op
catalog_object.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Versie
catalog_object.version integer

De huidige versie van dit object.

Wordt verwijderd
catalog_object.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

present_at_all_locations
catalog_object.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Naam
catalog_object.item_data.name string

De naam.

Description
catalog_object.item_data.title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Abbreviation
catalog_object.item_data.abbreviation string

De tekst van het weergavelabel van het item in de app Square Point of Sale. Alleen de eerste vijf tekens van de tekenreeks worden gebruikt. Dit kenmerk kan worden doorzocht en de waardelengte is van Unicode-codepunten.

Variaties
catalog_object.item_data.variations array of object
Typologie
catalog_object.item_data.variations.type string

Het type van dit object.

ID-kaart
catalog_object.item_data.variations.id string

Een id die naar dit object in de catalogus verwijst.

Bijgewerkt op
catalog_object.item_data.variations.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling.

Versie
catalog_object.item_data.variations.version integer

De versie van het object. Wanneer u een object bijwerkt, moet de opgegeven versie overeenkomen met de versie in de database, anders wordt de schrijfbewerking geweigerd als conflicterend.

Wordt verwijderd
catalog_object.item_data.variations.is_deleted boolean

Indien waar, is het object verwijderd uit de database. Moet onwaar zijn voor nieuwe objecten die worden ingevoegd. Wanneer het veld updated_at wordt verwijderd, is dit gelijk aan de verwijderingstijd.

Aanwezig op alle locaties
catalog_object.item_data.variations.present_at_all_locations boolean

Indien waar, is dit object aanwezig op alle locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld absent_at_location_ids. Als dit niet waar is, is dit object niet aanwezig op locaties (inclusief toekomstige locaties), behalve waar dit is opgegeven in het veld present_at_location_ids. Als dit niet is opgegeven, wordt standaard ingesteld op waar.

Item-id
catalog_object.item_data.variations.item_variation_data.item_id string

De id van de CatalogItem die is gekoppeld aan deze itemvariatie.

Naam
catalog_object.item_data.variations.item_variation_data.name string

De naam van de itemvariatie. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Rangtelwoord
catalog_object.item_data.variations.item_variation_data.ordinal integer

De volgorde waarin deze itemvariatie moet worden weergegeven. Deze waarde is alleen-lezen. Bij schrijfbewerkingen wordt het rangtelwoord voor elke itemvariatie binnen een bovenliggende CatalogItem ingesteld op basis van de positie van de itemvariaties. Bij leesbewerkingen is de waarde niet gegarandeerd sequentiële of unieke waarden.

Prijstype
catalog_object.item_data.variations.item_variation_data.pricing_type string

Hiermee wordt aangegeven of de prijs van de artikelvariatie is vast of bepaald op het moment van verkoop.

Voorraadbaar
catalog_object.item_data.variations.item_variation_data.stockable boolean

Of voorraad rechtstreeks op deze variatie (TRUE) wordt geteld of alleen op de onderdelen ervan (ONWAAR). Ontbrekende waarden voor achterwaartse compatibiliteit worden geïnterpreteerd als WAAR.

Aantal
catalog_object.item_data.variations.item_variation_data.price_money.amount integer

Het bedrag.

Valuta
catalog_object.item_data.variations.item_variation_data.price_money.currency string

De valuta.

Producttype
catalog_object.item_data.product_type string

Het producttype van het item. Kan niet worden gewijzigd zodra een item is gemaakt.

Id-toewijzingen
id_mappings array of object
Clientobject-id
id_mappings.client_object_id string

De door de client opgegeven tijdelijke #-voorvoegsel-id voor een nieuw CatalogObject.

Object-ID
id_mappings.object_id string

De permanente id die door de server is gemaakt.

Volgorde bijwerken (bèta)

Hiermee wordt een geopende volgorde bijgewerkt door velden toe te voegen, te vervangen of te verwijderen. Orders met de status VOLTOOID of GEANNULEERD kunnen niet worden bijgewerkt.

Parameters

Name Sleutel Vereist Type Description
Order-id
order_id True string

De id van de order.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Versie
version integer

De huidige versie van dit object.

UID
uid string

De door het vierkant gegenereerde id.

Hoeveelheid
quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Te wissen velden
fields_to_clear array of string

Retouren

Name Pad Type Description
Versie
order.version integer

De huidige versie van dit object.

Valuta
order.total_money.currency string

De valuta.

Aantal
order.total_money.amount integer

Het bedrag.

Naam
order.source.name string

De naam.

Regelitems
order.line_items array of object
Valuta
order.line_items.total_tax_money.currency string

De valuta.

Aantal
order.line_items.total_tax_money.amount integer

Het bedrag.

Aantal
order.line_items.total_money.amount integer

Het bedrag.

Valuta
order.line_items.total_money.currency string

De valuta.

Aantal
order.line_items.gross_sales_money.amount integer

Het bedrag.

Valuta
order.line_items.gross_sales_money.currency string

De valuta.

Aantal
order.line_items.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.base_price_money.currency string

De valuta.

Hoeveelheid
order.line_items.quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Valuta
order.line_items.total_discount_money.currency string

De valuta.

Aantal
order.line_items.total_discount_money.amount integer

Het bedrag.

Naam
order.line_items.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

UID
order.line_items.uid string

De door het vierkant gegenereerde id.

Aantal
order.line_items.variation_total_price_money.amount integer

Het bedrag.

Valuta
order.line_items.variation_total_price_money.currency string

De valuta.

Staat
order.state string

De huidige status.

Aantal
order.total_service_charge_money.amount integer

Het bedrag.

Valuta
order.total_service_charge_money.currency string

De valuta.

ID-kaart
order.id string

De unieke, door square uitgegeven id.

Locatie-id
order.location_id string

De id van de locatie.

Aantal
order.total_tax_money.amount integer

Het bedrag.

Valuta
order.total_tax_money.currency string

De valuta.

Gemaakt op
order.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Aantal
order.total_discount_money.amount integer

Het bedrag.

Valuta
order.total_discount_money.currency string

De valuta.

Valuta
order.net_amounts.service_charge_money.currency string

De valuta.

Aantal
order.net_amounts.service_charge_money.amount integer

Het bedrag.

Aantal
order.net_amounts.total_money.amount integer

Het bedrag.

Valuta
order.net_amounts.total_money.currency string

De valuta.

Valuta
order.net_amounts.discount_money.currency string

De valuta.

Aantal
order.net_amounts.discount_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tax_money.currency string

De valuta.

Aantal
order.net_amounts.tax_money.amount integer

Het bedrag.

Bijgewerkt op
order.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Volgorde klonen (bèta)

Hiermee maakt u een nieuwe volgorde in de status CONCEPT door een bestaande order te dupliceren. De zojuist gemaakte order heeft alleen de kernvelden (zoals regelitems, belastingen en kortingen) die uit de oorspronkelijke order zijn gekopieerd.

Parameters

Name Sleutel Vereist Type Description
Order-id
order_id string

De order-id.

Versie
version integer

De versie.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

Name Pad Type Description
ID-kaart
order.id string

De unieke, door square uitgegeven id.

Locatie-id
order.location_id string

De id van de locatie.

Regelitems
order.line_items array of object
UID
order.line_items.uid string

De door het vierkant gegenereerde id.

Naam
order.line_items.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Hoeveelheid
order.line_items.quantity string

Het aantal items dat wordt beïnvloed door het fysieke aantal als een decimaaltekenreeks. Het getal kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Toegepaste belastingen
order.line_items.applied_taxes array of object
UID
order.line_items.applied_taxes.uid string

Een door een vierkant toegewezen id.

Btw-UID
order.line_items.applied_taxes.tax_uid string

De UID van de belasting waarvoor deze toegepaste belasting staat.

Aantal
order.line_items.applied_taxes.applied_money.amount integer

Het bedrag.

Valuta
order.line_items.applied_taxes.applied_money.currency string

De valuta.

Toegepaste kortingen
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Een door een vierkant toegewezen id.

Kortings-UID
order.line_items.applied_discounts.discount_uid string

De uid van de korting die de toegepaste korting vertegenwoordigt.

Aantal
order.line_items.applied_discounts.applied_money.amount integer

Het bedrag.

Valuta
order.line_items.applied_discounts.applied_money.currency string

De valuta.

Aantal
order.line_items.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.base_price_money.currency string

De valuta.

Aantal
order.line_items.gross_sales_money.amount integer

Het bedrag.

Valuta
order.line_items.gross_sales_money.currency string

De valuta.

Aantal
order.line_items.total_tax_money.amount integer

Het bedrag.

Valuta
order.line_items.total_tax_money.currency string

De valuta.

Aantal
order.line_items.total_discount_money.amount integer

Het bedrag.

Valuta
order.line_items.total_discount_money.currency string

De valuta.

Aantal
order.line_items.total_money.amount integer

Het bedrag.

Valuta
order.line_items.total_money.currency string

De valuta.

Aantal
order.line_items.variation_total_price_money.amount integer

Het bedrag.

Valuta
order.line_items.variation_total_price_money.currency string

De valuta.

Catalogusobject-id
order.line_items.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Variatienaam
order.line_items.variation_name string

De naam van de variatie die op dit regelitem is toegepast.

Modificatoren
order.line_items.modifiers array of object
UID
order.line_items.modifiers.uid string

Een door een vierkant toegewezen id.

Catalogusobject-id
order.line_items.modifiers.catalog_object_id string

De object-id van de catalogus.

Naam
order.line_items.modifiers.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Aantal
order.line_items.modifiers.base_price_money.amount integer

Het bedrag.

Valuta
order.line_items.modifiers.base_price_money.currency string

De valuta.

Aantal
order.line_items.modifiers.total_price_money.amount integer

Het bedrag.

Valuta
order.line_items.modifiers.total_price_money.currency string

De valuta.

Belastingen
order.taxes array of object
UID
order.taxes.uid string

De door het vierkant gegenereerde id.

Naam
order.taxes.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Typologie
order.taxes.type string

Geeft het type aan.

Procent
order.taxes.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Aantal
order.taxes.applied_money.amount integer

Het bedrag.

Valuta
order.taxes.applied_money.currency string

De valuta.

Scope
order.taxes.scope string

Geeft het huidige niveau aan.

Kortingen
order.discounts array of object
UID
order.discounts.uid string

De door het vierkant gegenereerde id.

Catalogusobject-id
order.discounts.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Naam
order.discounts.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Typologie
order.discounts.type string

Geeft het type aan.

Procent
order.discounts.percentage string

Het percentage in decimale vorm, met behulp van een '.' als decimaalteken en zonder een '%'-teken. Een waarde van 7,5 komt overeen met 7,5%.

Aantal
order.discounts.applied_money.amount integer

Het bedrag.

Valuta
order.discounts.applied_money.currency string

De valuta.

Scope
order.discounts.scope string

Geeft het huidige niveau aan.

Aantal
order.discounts.amount_money.amount integer

Het bedrag.

Valuta
order.discounts.amount_money.currency string

De valuta.

Gemaakt op
order.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
order.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Staat
order.state string

De huidige status.

Versie
order.version integer

De huidige versie van dit object.

Referentie-id
order.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Aantal
order.total_money.amount integer

Het bedrag.

Valuta
order.total_money.currency string

De valuta.

Aantal
order.total_tax_money.amount integer

Het bedrag.

Valuta
order.total_tax_money.currency string

De valuta.

Aantal
order.total_discount_money.amount integer

Het bedrag.

Valuta
order.total_discount_money.currency string

De valuta.

Aantal
order.total_tip_money.amount integer

Het bedrag.

Valuta
order.total_tip_money.currency string

De valuta.

Aantal
order.total_service_charge_money.amount integer

Het bedrag.

Valuta
order.total_service_charge_money.currency string

De valuta.

Aantal
order.net_amounts.total_money.amount integer

Het bedrag.

Valuta
order.net_amounts.total_money.currency string

De valuta.

Aantal
order.net_amounts.tax_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tax_money.currency string

De valuta.

Aantal
order.net_amounts.discount_money.amount integer

Het bedrag.

Valuta
order.net_amounts.discount_money.currency string

De valuta.

Aantal
order.net_amounts.tip_money.amount integer

Het bedrag.

Valuta
order.net_amounts.tip_money.currency string

De valuta.

Aantal
order.net_amounts.service_charge_money.amount integer

Het bedrag.

Valuta
order.net_amounts.service_charge_money.currency string

De valuta.

Naam
order.source.name string

De naam.

Voorraadaantal ophalen

Hiermee wordt het huidige berekende aantal aandelen opgehaald voor een bepaald CatalogObject op een bepaalde set locaties.

Parameters

Name Sleutel Vereist Type Description
Catalogusobject-id
catalog_object_id True string

De id van het catalogusobject.

Locatie-id's
location_ids string

De locatie-id's die moeten worden opgezoekd als een door komma's gescheiden lijst. Een lege lijst voert een query uit op alle locaties.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Retouren

Name Pad Type Description
Telt
counts array of object
Catalogusobject-id
counts.catalog_object_id string

De door square gegenereerde id van het CatalogObject dat wordt bijgehouden.

Catalogusobjecttype
counts.catalog_object_type string

Het type CatalogObject dat wordt bijgehouden.

Staat
counts.state string

De huidige status.

Locatie-id
counts.location_id string

De id voor de locatie.

Hoeveelheid
counts.quantity string

Het aantal items dat wordt beïnvloed door het geschatte aantal als een decimale tekenreeks. Kan maximaal 5 cijfers na het decimaalteken ondersteunen.

Berekend op
counts.calculated_at string

Een RFC 3339-opgemaakt tijdstempel dat aangeeft wanneer het meest recente fysieke aantal of de meest recente aanpassing die van invloed is op het geschatte aantal wordt ontvangen.

Wijzigingslijsten voor items bijwerken

Hiermee werkt u de CatalogModifierList-objecten bij die van toepassing zijn op de beoogde CatalogItem zonder dat u een upsert hoeft uit te voeren op het hele item.

Parameters

Name Sleutel Vereist Type Description
Item-id's
item_ids array of string
Wijzigingslijsten om in te schakelen
modifier_lists_to_enable array of string
Wijzigingslijsten om uit te schakelen
modifier_lists_to_disable array of string

Retouren

Name Pad Type Description
Bijgewerkt op
updated_at string

De tijdstempel van de database van deze update in RFC 3339-indeling.

Zoekorders

Doorzoek alle orders naar een of meer locaties. Orders omvatten alle verkoop-, retour- en uitwisselingen, ongeacht hoe of wanneer ze het Square-ecosysteem hebben ingevoerd (zoals Point of Sale, Invoices en Connect-API's).

Parameters

Name Sleutel Vereist Type Description
Retourvermeldingen
return_entries boolean

Een Booleaanse waarde die de indeling van de zoekresultaten bepaalt. Indien waar, retourneert SearchOrders OrderEntry-objecten. Als dit onwaar is, retourneert SearchOrders volledige orderobjecten.

Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Locatie-id's
location_ids array of string
Beginnen bij
start_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik begint.

Eindigen op
end_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik eindigt.

States
states array of string
Sorteerveld
sort_field string

Het veld om op te sorteren.

Sorteervolgorde
sort_order string

De chronologische volgorde waarin de resultaten worden geretourneerd.

Retouren

Name Pad Type Description
Orderitems
order_entries array of object
Order-id
order_entries.order_id string

De id van de order.

Locatie-id
order_entries.location_id string

De id voor de locatie.

Versie
order_entries.version integer

De huidige versie van het object.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Definities

Voorwerp

Dit is het type 'object'.