-
Notifications
You must be signed in to change notification settings - Fork 755
/
Copy pathvendorInvoices.json
1349 lines (1349 loc) · 47.8 KB
/
vendorInvoices.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"description": "The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data.",
"version": "v1",
"title": "Selling Partner API for Retail Procurement Payments",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/vendor/payments/v1/invoices": {
"post": {
"tags": [
"vendorPayments"
],
"description": "Submit new invoices to Amazon.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "submitInvoices",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SubmitInvoicesRequest",
"example": {
"payload": {
"invoices": [
{
"invoiceType": "Invoice",
"id": "0136981234",
"date": "2019-07-24T21:17:59.821Z",
"remitToParty": {
"partyId": "XYZ12345",
"address": {
"name": "ANYCOMPANY MANUFACTURING",
"addressLine1": "123 ANY STREET",
"city": "ANYTOWN",
"stateOrRegion": "AZ",
"postalOrZipCode": "12345",
"countryCode": "USA"
},
"taxRegistrationDetails": [
{
"taxRegistrationType": "VAT",
"taxRegistrationNumber": "VENDORVATID"
}
]
},
"shipToParty": {
"partyId": "XYZ12345",
"address": {
"name": "ANYCOMPANY MANUFACTURING",
"addressLine1": "123 ANY STREET",
"city": "ANYTOWN",
"stateOrRegion": "AZ",
"countryCode": "USA"
}
},
"shipFromParty": {
"partyId": "XYZ12345",
"address": {
"name": "ANYCOMPANY MANUFACTURING",
"addressLine1": "123 ANY STREET",
"city": "ANYTOWN",
"stateOrRegion": "AZ",
"postalOrZipCode": "12345",
"countryCode": "USA"
}
},
"billToParty": {
"partyId": "XYZ12345",
"address": {
"name": "ANYCOMPANY MANUFACTURING",
"addressLine1": "123 ANY STREET",
"addressLine2": "",
"city": "ANYTOWN",
"stateOrRegion": "AZ",
"postalOrZipCode": "12345",
"countryCode": "USA"
},
"taxRegistrationDetails": [
{
"taxRegistrationType": "VAT",
"taxRegistrationNumber": "AMAZONVATNUMBER"
}
]
},
"paymentTerms": {
"type": "Basic",
"discountPercent": "5",
"discountDueDays": 15,
"netDueDays": 30
},
"invoiceTotal": {
"currencyCode": "INR",
"amount": "259678.39"
},
"taxDetails": [
{
"taxType": "SGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "19697.98"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "218866.43"
}
},
{
"taxType": "CGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "19697.98"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "218866.43"
}
}
],
"chargeDetails": [
{
"type": "Freight",
"description": "Freight Charges",
"chargeAmount": {
"currencyCode": "INR",
"amount": "1200.00"
},
"taxDetails": [
{
"taxType": "CGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "108.00"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "1200.00"
}
},
{
"taxType": "SGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "108.00"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "1200.00"
}
}
]
}
],
"items": [
{
"itemSequenceNumber": 1,
"amazonProductIdentifier": "ABC123434",
"vendorProductIdentifier": "809281-5100",
"invoicedQuantity": {
"amount": 2,
"unitOfMeasure": "Eaches"
},
"netCost": {
"currencyCode": "INR",
"amount": "21060.34"
},
"purchaseOrderNumber": "3DY3TK6T",
"hsnCode": "76.06.92.99.00",
"taxDetails": [
{
"taxType": "SGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "1895.43"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "21060.34"
}
},
{
"taxType": "CGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "1895.43"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "21060.34"
}
}
],
"chargeDetails": [
{
"type": "Freight",
"description": "Freight Charges",
"chargeAmount": {
"currencyCode": "INR",
"amount": "600.00"
}
}
]
},
{
"itemSequenceNumber": 2,
"amazonProductIdentifier": "ABC123435",
"vendorProductIdentifier": "795000-0001",
"invoicedQuantity": {
"amount": 3,
"unitOfMeasure": "Eaches"
},
"netCost": {
"currencyCode": "INR",
"amount": "58915.25"
},
"purchaseOrderNumber": "3DY3TK6T",
"taxDetails": [
{
"taxType": "SGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "5302.37"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "58915.25"
}
},
{
"taxType": "CGST",
"taxRate": "9",
"taxAmount": {
"currencyCode": "INR",
"amount": "5302.37"
},
"taxableAmount": {
"currencyCode": "INR",
"amount": "58915.25"
}
}
],
"chargeDetails": [
{
"type": "Freight",
"description": "Freight Charges",
"chargeAmount": {
"currencyCode": "INR",
"amount": "600.00"
}
}
]
}
]
}
]
}
}
},
"description": "The request body containing the invoice data to submit."
}
],
"responses": {
"202": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"examples": {
"application/json": {
"payload": {
"transactionId": "20190904171225-e1275c33-d75b-4bfe-b95c-15a9abfc09cc"
}
}
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"invoices": [
{
"id": "TestInvoice202",
"date": "2020-06-08T12:00:00.000Z",
"billToParty": {
"partyId": "TES1"
},
"invoiceType": "Invoice",
"remitToParty": {
"partyId": "ABCDE"
},
"invoiceTotal": {
"amount": "112.05",
"currencyCode": "USD"
}
}
]
}
}
}
},
"response": {
"payload": {
"transactionId": "20190904171225-e1275c33-d75b-4bfe-b95c-15a9abfc09cc"
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"invoices": [
{
"invoiceType": "Invoic"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Value 'Invoic' is not valid with respect to enumeration '[CreditNote, Invoice]'. It must be a value from the enumeration.",
"details": ""
},
{
"code": "InvalidInput",
"message": "The value 'Invoic' of element 'invoiceType' is not valid.",
"details": ""
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/SubmitInvoicesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
}
},
"definitions": {
"SubmitInvoicesResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the submitInvoices operation.",
"$ref": "#/definitions/TransactionId"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the submitInvoices operation."
},
"TransactionId": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
},
"description": "Response containing the transaction ID."
},
"ErrorList": {
"type": "array",
"description": "A list of error responses returned when a request is unsuccessful.",
"items": {
"$ref": "#/definitions/Error"
}
},
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occurred."
},
"message": {
"type": "string",
"description": "A message that describes the error condition."
},
"details": {
"type": "string",
"description": "Additional details that can help the caller understand or fix the issue."
}
},
"description": "Error response returned when the request is unsuccessful."
},
"SubmitInvoicesRequest": {
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/definitions/Invoice"
},
"description": "An array of Invoice objects representing the invoices or credit notes to be submitted."
}
},
"description": "The request schema for the submitInvoices operation."
},
"Invoice": {
"type": "object",
"required": [
"date",
"id",
"invoiceTotal",
"invoiceType",
"remitToParty"
],
"properties": {
"invoiceType": {
"type": "string",
"description": "Identifies the type of invoice.",
"enum": [
"Invoice",
"CreditNote"
],
"x-docgen-enum-table-extension": [
{
"value": "Invoice",
"description": "A commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer."
},
{
"value": "CreditNote",
"description": "A commercial document issued by a seller to a buyer. It is evidence of the reduction in sales."
}
]
},
"id": {
"type": "string",
"description": "Unique number relating to the charges defined in this document. This will be invoice number if the document type is Invoice or CreditNote number if the document type is Credit Note. Failure to provide this reference will result in a rejection."
},
"referenceNumber": {
"type": "string",
"description": "An additional unique reference number used for regulatory or other purposes."
},
"date": {
"description": "Date when the invoice/credit note information was generated in the origin's accounting system. The invoice date should be on or after the purchase order creation date.",
"$ref": "#/definitions/DateTime"
},
"remitToParty": {
"description": "Name, address and tax details of the party receiving the payment of this invoice.",
"$ref": "#/definitions/PartyIdentification"
},
"shipToParty": {
"description": "Name, address and tax details of the party receiving a shipment of products.",
"$ref": "#/definitions/PartyIdentification"
},
"shipFromParty": {
"description": "Name, address and tax details of the party sending a shipment of products.",
"$ref": "#/definitions/PartyIdentification"
},
"billToParty": {
"description": "Name, address and tax details of the party to whom this invoice is issued.",
"$ref": "#/definitions/PartyIdentification"
},
"paymentTerms": {
"description": "The payment terms for the invoice.",
"$ref": "#/definitions/PaymentTerms"
},
"invoiceTotal": {
"description": "Total monetary amount charged in the invoice or full value of credit note to be paid including all relevant taxes. It is the total amount of invoice (including charges, less allowances) before terms discount (if discount is applicable).",
"$ref": "#/definitions/Money"
},
"taxDetails": {
"type": "array",
"description": "Total tax amount details for all line items.",
"items": {
"$ref": "#/definitions/TaxDetails"
}
},
"additionalDetails": {
"type": "array",
"description": "Additional details provided by the selling party, for tax related or other purposes.",
"items": {
"$ref": "#/definitions/AdditionalDetails"
}
},
"chargeDetails": {
"type": "array",
"description": "Total charge amount details for all line items.",
"items": {
"$ref": "#/definitions/ChargeDetails"
}
},
"allowanceDetails": {
"type": "array",
"description": "Total allowance amount details for all line items.",
"items": {
"$ref": "#/definitions/AllowanceDetails"
}
},
"items": {
"type": "array",
"description": "The list of invoice items.",
"items": {
"$ref": "#/definitions/InvoiceItem"
}
}
},
"description": "Represents an invoice or credit note document with details about the transaction, parties involved, and line items."
},
"PartyIdentification": {
"description": "Name, address and tax details of a party.",
"type": "object",
"required": [
"partyId"
],
"properties": {
"partyId": {
"type": "string",
"description": "Assigned identification for the party."
},
"address": {
"description": "Identification of the party by address.",
"$ref": "#/definitions/Address"
},
"taxRegistrationDetails": {
"type": "array",
"description": "Tax registration details of the party.",
"items": {
"$ref": "#/definitions/TaxRegistrationDetails"
}
}
}
},
"TaxRegistrationDetails": {
"type": "object",
"required": [
"taxRegistrationNumber",
"taxRegistrationType"
],
"properties": {
"taxRegistrationType": {
"type": "string",
"description": "The tax registration type for the entity.",
"enum": [
"VAT",
"GST"
],
"x-docgen-enum-table-extension": [
{
"value": "VAT",
"description": "Value-added tax."
},
{
"value": "GST",
"description": "Goods and services tax."
}
]
},
"taxRegistrationNumber": {
"type": "string",
"description": "The tax registration number for the entity. For example, VAT ID, Consumption Tax ID."
}
},
"description": "Tax registration details of the entity."
},
"Address": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the person, business or institution at that address."
},
"addressLine1": {
"type": "string",
"description": "First line of street address."
},
"addressLine2": {
"type": "string",
"description": "Additional address information, if required."
},
"addressLine3": {
"type": "string",
"description": "Additional address information, if required."
},
"city": {
"type": "string",
"description": "The city where the person, business or institution is located."
},
"county": {
"type": "string",
"description": "The county where person, business or institution is located."
},
"district": {
"type": "string",
"description": "The district where person, business or institution is located."
},
"stateOrRegion": {
"type": "string",
"description": "The state or region where person, business or institution is located."
},
"postalOrZipCode": {
"type": "string",
"description": "The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation."
},
"countryCode": {
"type": "string",
"description": "The two digit country code. In ISO 3166-1 alpha-2 format.",
"maxLength": 2
},
"phone": {
"type": "string",
"description": "The phone number of the person, business or institution located at that address."
}
},
"description": "A physical address."
},
"InvoiceItem": {
"type": "object",
"required": [
"invoicedQuantity",
"itemSequenceNumber",
"netCost"
],
"properties": {
"itemSequenceNumber": {
"type": "integer",
"description": "Unique number related to this line item."
},
"amazonProductIdentifier": {
"type": "string",
"description": "Amazon Standard Identification Number (ASIN) of an item."
},
"vendorProductIdentifier": {
"type": "string",
"description": "The vendor selected product identifier of the item. Should be the same as was provided in the purchase order."
},
"invoicedQuantity": {
"description": "Invoiced quantity of this item. Quantity must be greater than zero.",
"$ref": "#/definitions/ItemQuantity"
},
"netCost": {
"description": "The item cost to Amazon, which should match the cost on the order. Price information should not be zero or negative. It indicates net unit price. Net cost means VAT is not included in cost. If items are priced by weight, this cost need to be considered in conjunction with netCostUnitOfMeasure. E.g.: $5/LB",
"$ref": "#/definitions/Money"
},
"netCostUnitOfMeasure": {
"description": "This field represents weight unit of measure of items that are ordered by cases and supporting priced by weight.",
"$ref": "#/definitions/NetCostUnitOfMeasure"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when invoiceType is Invoice, and is not required when invoiceType is CreditNote."
},
"hsnCode": {
"type": "string",
"description": "HSN Tax code. The HSN number cannot contain alphabets."
},
"creditNoteDetails": {
"description": "Details required in order to process a credit note. This information is required only if invoiceType is CreditNote.",
"$ref": "#/definitions/CreditNoteDetails"
},
"taxDetails": {
"type": "array",
"description": "Individual tax details per line item.",
"items": {
"$ref": "#/definitions/TaxDetails"
}
},
"chargeDetails": {
"type": "array",
"description": "Individual charge details per line item.",
"items": {
"$ref": "#/definitions/ChargeDetails"
}
},
"allowanceDetails": {
"type": "array",
"description": "Individual allowance details per line item.",
"items": {
"$ref": "#/definitions/AllowanceDetails"
}
}
},
"description": "Details of the item being invoiced."
},
"TaxDetails": {
"type": "object",
"required": [
"taxAmount",
"taxType"
],
"properties": {
"taxType": {
"type": "string",
"description": "Type of the tax applied.",
"enum": [
"CGST",
"SGST",
"CESS",
"UTGST",
"IGST",
"MwSt.",
"PST",
"TVA",
"VAT",
"GST",
"ST",
"Consumption",
"MutuallyDefined",
"DomesticVAT"
],
"x-docgen-enum-table-extension": [
{
"value": "CGST",
"description": "Central Goods and Services Tax (CGST) is levied by the Indian government for intrastate movement of goods and services."
},
{
"value": "SGST",
"description": "State Goods and Services Tax (SGST) is an indirect tax levied and collected by a State Government in India on the intra-state supplies."
},
{
"value": "CESS",
"description": "A CESS is a form of tax levied by the government on tax with specific purposes till the time the government gets enough money for that purpose."
},
{
"value": "UTGST",
"description": "Union Territory Goods and Services Tax in India."
},
{
"value": "IGST",
"description": "Integrated Goods and Services Tax (IGST) is a tax levied on all Inter-State supplies of goods and/or services in India."
},
{
"value": "MwSt.",
"description": "Mehrwertsteuer, MwSt, is German for value-added tax."
},
{
"value": "PST",
"description": "A provincial sales tax (PST) is imposed on consumers of goods and particular services in many Canadian provinces."
},
{
"value": "TVA",
"description": "Taxe sur la Valeur Ajoutée (TVA) is French for value-added tax."
},
{
"value": "VAT",
"description": "Value-added tax."
},
{
"value": "GST",
"description": "Tax levied on most goods and services sold for domestic consumption."
},
{
"value": "ST",
"description": "Sales tax."
},
{
"value": "Consumption",
"description": "Tax levied on consumption spending on goods and services."
},
{
"value": "MutuallyDefined",
"description": "Tax component that was mutually agreed upon between Amazon and vendor."
},
{
"value": "DomesticVAT",
"description": "Domestic value-added tax."
}
]
},
"taxRate": {
"description": "Tax percentage applied. Percentage must be expressed in decimal.",
"$ref": "#/definitions/Decimal"
},
"taxAmount": {
"description": "Total tax amount applied on invoice total or an item total.",
"$ref": "#/definitions/Money"
},
"taxableAmount": {
"description": "The invoice amount that is taxable at the rate specified in the tax rate field.",
"$ref": "#/definitions/Money"
}
},
"description": "Details of tax amount applied."
},
"Money": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"description": "Three-digit currency code in ISO 4217 format."
},
"amount": {
"$ref": "#/definitions/Decimal"
}
},
"description": "An amount of money, including units in the form of currency."
},
"AdditionalDetails": {
"type": "object",
"required": [
"detail",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the additional information provided by the selling party.",
"enum": [
"SUR",
"OCR",
"CartonCount"
],
"x-docgen-enum-table-extension": [
{
"value": "SUR",
"description": "An additional tax on something already taxed, such as a higher rate of tax on incomes above a certain level."
},
{
"value": "OCR",
"description": "OCR."
},
{
"value": "CartonCount",
"description": "The total number of cartons invoiced."
}
]
},
"detail": {
"type": "string",
"description": "The detail of the additional information provided by the selling party."
},
"languageCode": {
"type": "string",
"description": "The language code of the additional information detail."
}
},
"description": "Additional information provided by the selling party for tax-related or any other purpose."
},
"ChargeDetails": {
"type": "object",
"required": [
"chargeAmount",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Type of the charge applied.",
"enum": [