Avalara (wersja zapoznawcza)
Interfejs REST dla usługi podatkowej przedsiębiorstwa firmy Avalara, AvaTax w celu obliczenia podatku i rozwiązania adresu.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Klasa | Regiony |
|---|---|---|
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Nazwa | Microsoft Dynamics |
| adres URL | https://dynamics.microsoft.com/en-us/support/ |
| iomdri@microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://www.avalara.com/ |
| Zasady ochrony prywatności | https://www.avalara.com/us/en/legal/privacy-policy.html |
| Kategorie | Finance |
Ten łącznik został specjalnie opracowany do użycia na potrzeby integracji dostawcy usługi Avalara w usłudze Dynamics 365 Intelligent Order Management.
Wymagania wstępne
Postępuj zgodnie z instrukcjami w https://developer.avalara.com/communications/dev-guide_rest_v2/getting-started/account-creation/ temacie , aby utworzyć konto usługi Avalara.
Uwaga: zaleca się użycie tego łącznika w szczególności do skonfigurowania dostawcy usługi Dynamics 365 Intelligent Order Management Avalara.
Jak uzyskać poświadczenia
Usługa Avalara używa uwierzytelniania podstawowego z nazwą użytkownika i hasłem. Aby uzyskać więcej informacji, zobacz https://developer.avalara.com/communications/dev-guide_rest_v2/getting-started/authentication/ .
Wprowadzenie do łącznika
Skonfiguruj połączenie przy użyciu nazwy użytkownika, hasła i identyfikatora klienta. Aby dowiedzieć się więcej na temat interfejsu API usługi Avalara, przeczytaj publiczną dokumentację: https://developer.avalara.com/api-reference/avatax/rest/v2/
Znane problemy i ograniczenia
Ten łącznik został specjalnie opracowany do użycia na potrzeby integracji dostawcy usługi Avalara w usłudze Dynamics 365 Intelligent Order Management. Obsługa przypadków użycia poza usługą Dynamics 365 Intelligent Order Management będzie ograniczona.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Nazwa | Typ | Opis | Wymagane |
|---|---|---|---|
| Nazwa użytkownika | securestring | Nazwa użytkownika dla tego interfejsu API | Prawda |
| Hasło | securestring | Hasło dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Rozwiązanie adresu |
Ta akcja rozwiązuje problem. |
| Tworzenie transakcji |
Ta akcja powoduje utworzenie nowej transakcji. |
Rozwiązanie adresu
Ta akcja rozwiązuje problem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
|
object |
Zwraca
Model rozpoznawania adresów
Tworzenie transakcji
Ta akcja powoduje utworzenie nowej transakcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
|
object |
Zwraca
- response
- array of TransactionModel
Definicje
TransactionModel
Pojedyncza transakcja — na przykład faktura sprzedaży lub zamówienie zakupu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator tej transakcji |
|
kod
|
code | string |
Unikatowy kod dostarczony przez klienta identyfikujący tę transakcję |
|
date
|
date | string |
Data wystąpienia tej transakcji |
|
taxDate
|
taxDate | string |
Data podatku dla tej transakcji |
|
data płatności
|
paymentDate | string |
Data dokonania płatności w ramach tej transakcji. |
|
stan
|
status | string |
Stan transakcji |
|
typ
|
type | string |
Typ transakcji |
|
companyId
|
companyId | integer |
Unikatowy identyfikator firmy, która zarejestrowała tę transakcję |
|
batchCode
|
batchCode | string |
Jeśli ta transakcja została utworzona w ramach partii, ten kod wskazuje, która partia |
|
kod waluty
|
currencyCode | string |
Trzyznaczny kod waluty ISO 4217, który został użyty do płatności za tę transakcję |
|
customerUsageType
|
customerUsageType | string |
Typ użycia klienta dla tej transakcji |
|
customerVendorCode
|
customerVendorCode | string |
Kod klienta dla tej transakcji |
|
exemptNo
|
exemptNo | string |
Numer nip klienta (tax_number) skojarzony z certyfikatem |
|
Pogodzić
|
reconciled | boolean |
Jeśli ta transakcja została uzgodniona z rejestrem firmy, ta wartość jest ustawiona na true |
|
locationCode
|
locationCode | string |
Kod lokalizacji raportowania |
|
purchaseOrderNo
|
purchaseOrderNo | string |
Podany przez klienta numer zamówienia zakupu tej transakcji |
|
referenceCode
|
referenceCode | string |
Kod referencyjny zdefiniowany przez użytkownika dla tej transakcji |
|
salespersonCode
|
salespersonCode | string |
Sprzedawca, który dostarczył tę transakcję. Niewymagane |
|
taxOverrideType
|
taxOverrideType | string |
W przypadku zastosowania przesłonięcia podatkowego do tej transakcji wskazuje, jaki rodzaj przesłonięcia podatku został zastosowany |
|
taxOverrideAmount
|
taxOverrideAmount | float |
f zastąpienie podatku zostało zastosowane do tej transakcji, wskazuje kwotę podatku, który został żądany przez klienta |
|
taxOverrideReason
|
taxOverrideReason | string |
Jeśli zastąpienie podatku zostało zastosowane do tej transakcji, wskazuje przyczynę zastąpienia podatku |
|
kwotaCałkowita
|
totalAmount | float |
Łączna kwota tej transakcji |
|
totalExempt
|
totalExempt | float |
Kwota tej transakcji, która była zwolniona |
|
totalTax
|
totalTax | float |
Łączny podatek dla wszystkich wierszy w tej transakcji. |
|
totalTaxable
|
totalTaxable | float |
Część całkowitej kwoty tej transakcji, która była podatna na opodatkowanie |
|
totalTaxCalculated
|
totalTaxCalculated | float |
Kwota podatku obliczona dla transakcji przez AvaTax. |
|
adjustmentReason
|
adjustmentReason | string |
Jeśli ta transakcja została skorygowana, wskazuje unikatowy identyfikator przyczyny, dla którego transakcja została skorygowana |
|
adjustmentDescription
|
adjustmentDescription | string |
Jeśli ta transakcja została skorygowana, wskazuje opis przyczyny dostosowania transakcji |
|
zablokowany
|
locked | boolean |
Jeśli ta transakcja została zgłoszona urzędowi podatkowemu, ta transakcja jest uważana za zablokowaną i może nie zostać skorygowana po zgłoszeniu |
|
region
|
region | string |
Kod regionu ISO o dwóch lub trzech znakach dla tej transakcji |
|
country
|
country | string |
Dwuznaczny kod ISO 3166 kraju dla tej transakcji |
|
wersja
|
version | integer |
Jeśli ta transakcja została skorygowana, oznacza to numer wersji tej transakcji. Zwiększane za każdym razem, gdy transakcja jest dostosowywana |
|
softwareVersion
|
softwareVersion | string |
Wersja oprogramowania używana do obliczania tej transakcji |
|
originAddressId
|
originAddressId | integer |
Unikatowy identyfikator adresu początkowego dla tej transakcji |
|
destinationAddressId
|
destinationAddressId | integer |
Unikatowy identyfikator adresu docelowego dla tej transakcji |
|
exchangeRateEffectiveDate
|
exchangeRateEffectiveDate | string |
Jeśli ta transakcja obejmowała wymianę walut obcych, jest to data, od której obliczono kurs wymiany |
|
exchangeRate
|
exchangeRate | float |
Jeśli ta transakcja obejmowała walutę zagraniczną, jest to kurs wymiany, który został użyty |
|
isSellerImporterOfRecord
|
isSellerImporterOfRecord | boolean |
Jeśli to prawda, sprzedawca został uznany za importera dokumentacji produktu dostarczonego na arenie międzynarodowej |
|
opis
|
description | string |
Opis tej transakcji. Pole zezwala na wartości Unicode |
|
e-mail
|
string |
Adres e-mail skojarzony z tą transakcją |
|
|
brBuyerType
|
brBuyerType | string |
Typ nabywcy |
|
brBuyer_IsExemptOrCannotWH_IRRF
|
brBuyer_IsExemptOrCannotWH_IRRF | boolean |
Czy kupujący jest zwolniony z wstrzymania IRRF |
|
brBuyer_IsExemptOrCannotWH_PISRF
|
brBuyer_IsExemptOrCannotWH_PISRF | boolean |
Czy kupujący jest zwolniony z wstrzymania PIS |
|
brBuyer_IsExemptOrCannotWH_COFINSRF
|
brBuyer_IsExemptOrCannotWH_COFINSRF | boolean |
Czy kupujący jest zwolniony z wstrzymania COFINS |
|
brBuyer_IsExemptOrCannotWH_CSLLRF
|
brBuyer_IsExemptOrCannotWH_CSLLRF | boolean |
Czy kupujący jest zwolniony z wstrzymania CSLL |
|
brBuyer_IsExempt_PIS
|
brBuyer_IsExempt_PIS | boolean |
Czy kupujący jest zwolniony z opodatkowania i potrącenia PIS |
|
brBuyer_IsExempt_COFINS
|
brBuyer_IsExempt_COFINS | boolean |
Czy kupujący jest zwolniony z opodatkowania i potrącenia COFINS |
|
brBuyer_IsExempt_CSLL
|
brBuyer_IsExempt_CSLL | boolean |
Czy nabywca jest zwolniony z opodatkowania i potrącenia CSLL |
|
modifiedDate
|
modifiedDate | string |
Data/godzina ostatniej modyfikacji tego rekordu (tylko do odczytu) |
|
modifiedUserId
|
modifiedUserId | integer |
Identyfikator użytkownika, który ostatnio zmodyfikował ten rekord (tylko do odczytu) |
|
Linie
|
lines | array of TransactionLineModel |
Lista wierszy w tej transakcji |
|
addresses
|
addresses | array of TransactionAddressModel |
Lista adresów używanych w tej transakcji |
TransactionLineModel
Jeden element wiersza dla tej transakcji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator tego elementu wiersza transakcji |
|
transactionId (identyfikator transakcji)
|
transactionId | integer |
Unikatowy identyfikator transakcji, do której należy ten element wiersza |
|
numer linii
|
lineNumber | string |
Numer wiersza lub kod wskazujący wiersz na tej fakturze, paragonie lub dokumencie |
|
metoda
|
method | string |
Sposób księgowania |
|
boundaryOverrideId
|
boundaryOverrideId | integer |
Unikatowy identyfikator przesłonięcia granicy zastosowanego do tego elementu wiersza |
|
customerUsageType
|
customerUsageType | string |
Typ użycia klienta dla tego elementu wiersza |
|
opis
|
description | string |
Opis elementu lub usługi reprezentowanej przez ten wiersz |
|
destinationAddressId
|
destinationAddressId | integer |
Unikatowy identyfikator adresu docelowego, w którym został dostarczony lub sprzedany ten wiersz |
|
discountAmount
|
discountAmount | float |
Kwota rabatu, która została zastosowana do tego elementu wiersza |
|
discountTypeId
|
discountTypeId | integer |
Typ rabatu, jeśli istnieje, który został zastosowany do tego elementu wiersza |
|
exemptAmount
|
exemptAmount | float |
Ilość tego elementu wiersza, który był wykluczony |
|
exemptCertId
|
exemptCertId | integer |
Unikatowy identyfikator certyfikatu wykluczenia zastosowanego do tego elementu wiersza |
|
exemptNo
|
exemptNo | string |
Numer nip klienta (tax_number) skojarzony z certyfikatem |
|
isItemTaxable
|
isItemTaxable | boolean |
Prawda, jeśli ten przedmiot jest podlegający opodatkowaniu |
|
isSSTP
|
isSSTP | boolean |
Prawda, jeśli ten element jest usprawniony element wiersza podatku od sprzedaży |
|
itemCode
|
itemCode | string |
Ciąg kodu elementu reprezentowanego przez ten element wiersza |
|
lineAmount
|
lineAmount | float |
Całkowita kwota transakcji, w tym zarówno podlegający opodatkowaniu, jak i zwolnione |
|
originAddressId
|
originAddressId | integer |
Identyfikator adresu źródła |
|
ilość
|
quantity | float |
Ilość produktów sprzedawanych w tym wierszu |
|
ref1
|
ref1 | string |
Identyfikator referencyjny zdefiniowany przez użytkownika dla tego elementu wiersza transakcji |
|
ref2
|
ref2 | string |
Identyfikator referencyjny zdefiniowany przez użytkownika dla tego elementu wiersza transakcji |
|
Reportingdate
|
reportingDate | string |
Data zgłoszenia tej transakcji |
|
revAccount
|
revAccount | string |
Numer konta przychodu dla tego elementu wiersza |
|
Pozyskiwania
|
sourcing | string |
Wskazuje, czy ten element wiersza został opodatkowany zgodnie z pochodzeniem lub miejscem docelowym |
|
podatek
|
tax | float |
Podatek dla tego wiersza w tej transakcji |
|
taxableAmount
|
taxableAmount | float |
Kwota podatku od tego elementu wiersza |
|
taxCalculated
|
taxCalculated | float |
Kwota podatku obliczona dla transakcji przez AvaTax |
|
taxCode
|
taxCode | string |
Ciąg kodu dla kodu podatkowego, który został użyty do obliczenia tego elementu wiersza |
|
taxCodeId
|
taxCodeId | integer |
Unikatowy numer identyfikacyjny kodu podatkowego, który został użyty do obliczenia tego elementu wiersza |
|
taxDate
|
taxDate | string |
Data, która została użyta do obliczenia kwot podatkowych dla tego elementu wiersza |
|
taxEngine
|
taxEngine | string |
Identyfikator aparatu podatkowego, który został użyty do obliczenia tego elementu wiersza |
|
taxOverrideType
|
taxOverrideType | string |
Jeśli określono przesłonięć podatkową, wskazuje to typ zastąpienia podatkowego |
|
taxOverrideAmount
|
taxOverrideAmount | float |
Jeśli określono przesłonięć podatku, wskazuje to kwotę podatku, którego zażądano |
|
taxOverrideReason
|
taxOverrideReason | string |
Jeśli określono przesłonięć podatku, reprezentuje przyczynę zastąpienia podatku |
|
taxIncluded
|
taxIncluded | boolean |
Wskazuje, czy kwota dla tego wiersza zawiera już podatek |
|
details
|
details | array of TransactionLineDetailModel |
Lista szczegółów podatkowych dla tego elementu wiersza |
TransactionAddressModel
Adres używany w ramach tej transakcji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator tego adresu |
|
transactionId (identyfikator transakcji)
|
transactionId | integer |
Unikatowy numer identyfikacyjny dokumentu, do którego należy ten adres |
|
boundaryLevel
|
boundaryLevel | string |
Poziom granicy, na którym ten adres został zweryfikowany |
|
line1
|
line1 | string |
Pierwszy wiersz adresu |
|
line2
|
line2 | string |
Drugi wiersz adresu |
|
line3
|
line3 | string |
Trzeci wiersz adresu |
|
city
|
city | string |
Miasto adresu |
|
region
|
region | string |
Kod regionu ISO 3166. Na przykład druga część ISO 3166-2 |
|
postalCode
|
postalCode | string |
Kod pocztowy lub kod pocztowy adresu |
|
country
|
country | string |
Kod kraju ISO 3166 |
|
taxRegionId
|
taxRegionId | integer |
Unikatowy numer identyfikacyjny regionu podatkowego dla tego adresu |
TransactionLineDetailModel
Indywidualny element szczegółów podatkowych dla tego wiersza
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy numer identyfikacyjny tego szczegóły podatkowego |
|
transactionLineId
|
transactionLineId | integer |
Unikatowy identyfikator wiersza w ramach tej transakcji |
|
transactionId (identyfikator transakcji)
|
transactionId | integer |
Unikatowy identyfikator tej transakcji |
|
addressId
|
addressId | integer |
Unikatowy numer identyfikacyjny adresu używanego dla tego szczegóły podatkowego |
|
country
|
country | string |
Dwuznaczny kod kraju ISO 3166 kraju, w którym przypisano ten szczegół podatkowy |
|
region
|
region | string |
Dwuznaczny kod regionu ISO dwuznaczny dla regionu, w którym przypisano ten szczegół podatkowy |
|
countyFIPS
|
countyFIPS | string |
W przypadku transakcji w USA kod Federal Information Processing Standard (FIPS) dla hrabstwa, w którym przypisano te szczegóły podatkowe |
|
stateFIPS
|
stateFIPS | string |
W przypadku transakcji w USA kod Federal Information Processing Standard (FIPS) dla stanu, w którym przypisano te szczegóły podatkowe |
|
exemptAmount
|
exemptAmount | float |
Kwota tego wiersza, która została uznana za zwolnioną w tym szczegółach podatkowych |
|
exemptReasonId
|
exemptReasonId | integer |
Unikatowy numer identyfikacyjny przyczyny zwolnienia z tego podatku |
|
inState
|
inState | boolean |
Prawda, jeśli ten element szczegółów reprezentował transakcję w stanie |
|
jurisCode
|
jurisCode | string |
Kodeks jurysdykcji, do której stosuje się ten szczegół podatkowy |
|
jurisName
|
jurisName | string |
Nazwa jurysdykcji, do której stosuje się ten szczegół podatkowy |
|
jurisdictionId
|
jurisdictionId | integer |
Unikatowy numer identyfikacyjny jurysdykcji, do której stosuje się ten szczegół podatkowy |
|
jurisType
|
jurisType | string |
Rodzaj jurysdykcji, do której stosuje się ten szczegół podatkowy |
|
nonTaxableAmount
|
nonTaxableAmount | float |
Kwota tego elementu wiersza, która została uznana za nieopodatkowaną w tym szczegółach podatkowych |
|
nonTaxableRuleId
|
nonTaxableRuleId | integer |
Reguła, zgodnie z którą część tego szczegółu została uznana za niemożliwą do zniesienia |
|
nonTaxableType
|
nonTaxableType | string |
Rodzaj nienależności, który został zastosowany do tego szczegóły podatkowego |
|
wskaźnik
|
rate | float |
Stawka, z jaką obliczono ten podatek |
|
rateRuleId
|
rateRuleId | integer |
Unikatowy numer identyfikacyjny reguły, zgodnie z którą obliczono ten szczegół podatkowy |
|
rateSourceId
|
rateSourceId | integer |
Unikatowy numer identyfikacyjny źródła stawki, zgodnie z którą obliczono ten szczegół podatkowy |
|
signatureCode
|
signatureCode | string |
Określony przez Avalara kod podpisu jurysdykcji, do której stosuje się ten szczegół podatkowy |
|
serCode
|
serCode | string |
W przypadku usprawnionych klientów podatku od sprzedaży, kod elektronicznego zeznania SST, w ramach którego należy zastosować te szczegóły podatkowe |
|
Pozyskiwania
|
sourcing | string |
Wskazuje, czy ten szczegół podatkowy ma zastosowanie do źródła lub miejsca docelowego transakcji |
|
stateAssignedNo
|
stateAssignedNo | string |
Przypisany przez państwo numer jurysdykcji, do której stosuje się ten szczegół podatkowy |
|
podatek
|
tax | float |
Kwota podatku dla tej szczegółów podatkowych |
|
taxableAmount
|
taxableAmount | float |
Kwota podatkowa tej szczegółów podatkowych |
|
taxType
|
taxType | string |
Typ podatku, który został obliczony |
|
taxName
|
taxName | string |
Nazwa podatku, od którego obliczono tę kwotę podatku |
|
taxAuthorityTypeId
|
taxAuthorityTypeId | integer |
Rodzaj organu podatkowego, do którego ten podatek zostanie wyemitowany |
|
taxRegionId
|
taxRegionId | integer |
Unikatowy identyfikator regionu podatkowego |
|
taxCalculated
|
taxCalculated | float |
Kwota podatku obliczona przez AvaTax |
|
taxOverride
|
taxOverride | float |
Kwota zastąpienia podatku określona dla tej linii podatkowej |
|
rateType
|
rateType | string |
Typ stawki dla tego podatku |
AddressInfo
Reprezentuje adres do rozpoznania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
line1
|
line1 | string |
Pierwszy wiersz adresu |
|
line2
|
line2 | string |
Drugi wiersz adresu |
|
line3
|
line3 | string |
Trzecia linia adresu ulicznego |
|
city
|
city | string |
Składnik miasta adresu |
|
region
|
region | string |
Nazwa lub kod ISO 3166 identyfikujący region w kraju |
|
country
|
country | string |
Nazwa lub kod ISO 3166 identyfikujący kraj |
|
postalCode
|
postalCode | string |
Kod pocztowy /składnik kodu pocztowego adresu |
|
latitude
|
latitude | float |
Pomiar szerokości geograficznej |
|
długość geograficzna
|
longitude | float |
Pomiar długości geograficznej geoprzestrzennych |
AddressResolutionModel
Model rozpoznawania adresów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
address
|
address | AddressInfo |
Reprezentuje adres do rozpoznania |
|
współrzędne
|
coordinates | CoordinateInfo |
Informacje o współrzędnych |
|
resolutionQuality
|
resolutionQuality | string |
Jakość rozdzielczości współrzędnych geoprzestrzennych |
|
taxAuthorities
|
taxAuthorities | array of TaxAuthorityInfo |
Wykaz organów podatkowych mających zastosowanie do tej współrzędnej geoprzestrzennej |
Informacje o współrzędnych
Informacje o współrzędnych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
latitude
|
latitude | float |
Szerokość |
|
długość geograficzna
|
longitude | float |
długość geograficzna |
TaxAuthorityInfo
Informacje o urzędzie podatkowym
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
avalaraId
|
avalaraId | string |
Identyfikator Avalara |
|
jurisdictionName
|
jurisdictionName | string |
Nazwa jurysdykcji |
|
jurisdictionType
|
jurisdictionType | string |
Typ jurysdykcji |
|
signatureCode
|
signatureCode | string |
Kod podpisu |