<a name="概述">
# 概述
零售采购支付的销售伙伴API提供了对供应商支付数据的程序化访问.
# Version information
版本 : v1
# Operations
submitInvoices
<a name="paths">
# 路径
<a name="submitinvoices">
# submitInvoices
POST /vendor/payments/v1/invoices
# Description
向亚马逊提交新的发票.
使用计划:
计划类型 | 速率(每秒请求数) | 突发 |
---|---|---|
Default | 10 | 10 |
销售伙伴具体 | 变量 | 变量 |
x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | 提交发票操作的请求模式. | SubmitInvoicesRequest |
# Responses
HTTP Code | Description | Schema |
---|---|---|
202 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | SubmitInvoicesResponse |
错误状态代码、描述和模式,见错误响应和模式.
<a name="error-responses-and-schemas">
# 错误响应和模式
本表包含HTTP状态代码和错误响应的相关信息.
HTTP Code | Description | Schema |
---|---|---|
400 | Request有缺失或无效的参数,无法解析. Headers x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | SubmitInvoicesResponse |
403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. **头信息 x-amzn-RequestId (string):Unique request reference identifier. | SubmitInvoicesResponse |
404 | 指定的资源不存在. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string): unique request reference identifier. | SubmitInvoicesResponse |
413 | 请求的大小超过了可接受的最大大小. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoicesResponse |
415 | 请求的有效载荷是不支持的格式. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoicesResponse |
429 | 请求的频率超过了允许的范围. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoicesResponse |
500 | 发生了一个意外情况,使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoicesResponse |
503 | 服务器临时超载或维护. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作._注意 _对于这个状态码,速率限制头已经过时,不再返回. x-amzn-RequestId (string):唯一的请求参考标识. | SubmitInvoicesResponse |
<a name="definitions">
# Definitions
<a name="submitinvoicesresponse">## 定义
# SubmitInvoicesResponse
提交发票操作的响应模式.
Name | Description | Schema |
---|---|---|
payload optional | 提交发票操作的响应有效载荷. | TransactionId |
errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
<a name="transactionid">
# TransactionId
Name | Description | Schema |
---|---|---|
transactionId optional | GUID来识别这个交易.这个值可以和交易状态API一起使用来返回这个交易的状态. | string |
<a name="errorlist">
# ErrorList
当请求不成功时返回的错误响应列表.
类型 < Error > 数组
<a name="error">
# Error
当请求不成功时返回的错误响应.
Name | Description | Schema |
---|---|---|
code required | 一个错误代码,用于识别所发生的错误类型. | string |
message required | 一个描述错误情况的信息. | string |
details optional | 可以帮助呼叫者理解或解决这个问题的额外细节. | string |
<a name="submitinvoicesrequest">
# SubmitInvoicesRequest
提交发票操作的请求模式.
Name | Schema |
---|---|
invoices optional | < Invoice > array |
<a name="发票">
# Invoice
Name | Description | Schema |
---|---|---|
invoiceType required | 标识发票的类型. | enum (InvoiceType) |
id required | 与本文件中定义的费用有关的独特号码.如果文件类型是发票,这将是发票号码,如果文件类型是信用票据,这将是信用票据号码.未能提供这一参考将导致拒绝. | string |
referenceNumber optional | 用于监管或其他目的的额外独特参考号码. | string |
日期 必须的 | 在原产地会计系统中生成发票/信用证信息的日期.发票日期应该是在采购订单创建日期或之后. | 日期时间 |
remitToParty required | 接收此发票付款的一方的姓名、地址和税务细节. | PartyIdentification |
*shipToParty optional | 接收产品运输的一方的姓名、地址和税务细节. | PartyIdentification |
|billToParty
optional|被开具此发票的一方的姓名、地址和税务详情.|PartyIdentification|
|支付条款
可选|发票的支付条款.|支付条款|
|invoiceTotal
required|发票中收取的货币总额或应支付的信用证全额,包括所有相关的税费.它是发票的总金额(包括费用,减去津贴)在条款折扣之前(如果折扣适用).|Money|
|taxDetails
optional|所有项目的总税额详情.|< TaxDetails> array|
|additionalDetails
optional|由销售方提供的额外细节,用于税务相关或其他目的.|< AdditionalDetails > array|
|chargeDetails
optional|所有项目的总收费金额详情.|< ChargeDetails> array|
|allowanceDetails
optional|所有项目的总津贴金额详情.|< AllowanceDetails> array|
|items
optional|发票项目列表.|< InvoiceItem > array|
<a name="partyidentification">
# PartyIdentification
Name | Description | Schema |
---|---|---|
partyId required | 为当事人分配的标识. | string |
address optional | 按地址确定的当事人身份. | Address |
税务登记细节 可选 | 当事人的税务登记细节. | < TaxRegistrationDetails >数组 |
<a name="taxregistrationdetails">
# TaxRegistrationDetails
实体的税务登记详情.
Name | Description | Schema |
---|---|---|
xRegistrationType required | 实体的税务登记类型. | enum (TaxRegistrationType) |
税务登记号码 必须的 | 实体的税务登记号码.例如,增值税ID. | 字符串 |
<a name="地址">
# Address
一个物理地址.
Name | Description | Schema |
---|---|---|
name required | 该地址的个人、企业或机构的名称. | string |
addressLine1 required | 街道地址的第一行. | string |
addressLine2 可选的 | 额外的地址信息,如果需要的话. | string |
addressLine3 optional | Additional address information, if required. | string |
city optional | 个人、企业或机构所在的城市. | string |
县 可选择 | 个人、企业或机构所在的县. | string |
区 可选择 | 个人、企业或机构所在的区. | string |
州或地区 可选择 | 个人、企业或机构所在的州或地区. | string |
postalOrZipCode optional | 该地址的邮政或邮政编码.它包含一系列的字母或数字或两者,有时包括空格或标点符号. | string |
countryCode required | 两位数的国家代码.以ISO 3166-1 alpha-2格式. maxLength : 2 | string |
phone optional | 位于该地址的个人、企业或机构的电话号码. | string |
<a name="invoiceitem">
# InvoiceItem
被开具发票的项目的详细信息.
Name | Description | Schema |
---|---|---|
itemSequenceNumber required | Unique number related to this line item. | integer |
amazonProductIdentifier optional | 亚马逊标准识别码(ASIN)的一个项目. | string |
vendorProductIdentifier optional | 供应商选择的商品标识.应与采购订单中提供的相同. | string |
invoicedQuantity required | 这个项目的发票数量.数量必须大于零. | ItemQuantity |
netCost required | 对亚马逊的商品成本,应该与订单上的成本一致.价格信息不应该是零或负数.它表示净单位价格.净成本意味着成本中不包括增值税. | Money |
purchaseOrderNumber optional | 该发票项目的亚马逊采购订单号.格式说明8-character alpha-numeric code.这个值只有在invoiceType为Invoice时才是必须的,而在invoiceType为CreditNote. | string |
hsnCode optional | HSN税号. HSN号码不能包含字母. | string |
creditNoteDetails optional | Details required in order to process a credit note. This information is required only if invoiceType is CreditNote. | CreditNoteDetails |
taxDetails optional | 每一行的个人税收细节. | < TaxDetails> array |
chargeDetails optional | 每行项目的个人收费详情. | < ChargeDetails > array |
allowanceDetails optional | 每一行的个人津贴详情. | < AllowanceDetails > array |
<a name="taxdetails">
# TaxDetails
适用的税额详情.
Name | Description | Schema |
---|---|---|
taxType required | Type of the tax applied. | enum (TaxType |
税率 可选 | 适用的税收百分比.百分比必须以十进制表示. | Decimal |
taxAmount required | 应用于发票总额或项目总额的总税额. | Money |
taxableAmount optional | 按照税率字段中指定的税率应纳税的发票金额. | Money |
<a name="money">
# Money
一笔钱,包括货币形式的单位.
Name | Description | Schema |
---|---|---|
currencyCode optional | 三位数的ISO 4217格式的货币代码. | string |
amount optional | A十进制数字,没有精度损失.当精度损失不可接受时,非常有用,如货币.遵循RFC7159的数字表示法. Pattern : ^-?(0\|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$ . | Decimal |
<a name="additionaldetails">
# AdditionalDetails
卖方为税收-相关或任何其他目的提供的额外信息.
Name | Description | Schema |
---|---|---|
类型 要求 | 销售方提供的附加信息的类型. | enum (Type) |
detail required | 由销售方提供的附加信息的细节. | string |
languageCode optional | 附加信息细节的语言代码. | string |
<a name="chargeetails">
# ChargeDetails
收费的货币和税收详情.
Name | Description | Schema |
---|---|---|
类型 要求 | 应用的收费类型. | enum (Type) |
description optional | Description of the charge. | string |
chargeAmount required | 与此费用有关的总金额. | Money |
taxDetails optional | 适用于此费用的税额细节. | < TaxDetails > array |
<a name="allowancedetails">
# AllowanceDetails
补贴的货币和税收细节.
Name | Description | Schema |
---|---|---|
类型 要求 | 应用的津贴类型. | enum (Type) |
description optional | Description of the allowance. | string |
*allowanceAmount required | 与此津贴有关的货币总额. | Money |
taxDetails optional | 适用于此津贴的税额细节. | < TaxDetails > array |
<a name="paymentterms">
# PaymentTerms
发票的付款条件.付款条件的基础是发票日期.
Name | Description | Schema |
---|---|---|
类型 可选 | 发票的付款期限类型. | enum (Type) |
discountPercent optional | 折扣百分比值,该值在折扣到期日之前有效. | Decimal |
discountDueDays optional | 从基准日(发票日)起至折扣不再有效的日历天数. | number |
netDueDays optional | 从基准日期(发票日期)到发票上的总金额到期的日历天数. | number |
<a name="creditnotedetails">
# CreditNoteDetails
处理信用证所需的参考资料.只有当InvoiceType为CreditNote时才需要此信息.
Name | Description | Schema |
---|---|---|
referenceInvoiceNumber optional | 在发送与现有发票有关的信用证时的原始发票号码.每张信用证只能处理一张发票.这是AP信用证的必选项. | string |
debitNoteNumber optional | Debit Note Number as generated by Amazon. Recommended for Returns and COOP Credit Notes. | string |
returnsReferenceNumber optional | 标识退货通知编号.所有退货信用票据必须使用. | string |
goodsReturnDate optional | 供应商收到退货的日期.对于退货信用通知书来说是强制性的. | DateTime |
rmaId optional | 标识退货商品授权ID,如果产生的话. | string |
COOPReferenceNumber optional | 标识用于COOP协议的COOP参考号码.如果不提供COOP参考号码或借据号码,可能会导致信用证被拒绝. | string |
consignorsReferenceNumber optional | 识别发货人参考号码(VRET号码),如果由亚马逊生成. | string |
<a name="itemquantity">
# ItemQuantity
数量的详情.
Name | Description | Schema |
---|---|---|
amount required | Quantity of an item.这个值不应该是零. | integer |
单元测量 required | 数量的测量单位. | enum (单元测量) |
unitSize optional | 案件大小,如果计量单位值是Cases. | integer |
<a name="十进制">
# Decimal
一个没有精度损失的十进制数.当精度损失是不可接受的时候很有用,比如货币.遵循RFC7159的数字表示法.
模式^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$
.
类型:字符串
<a name="datetime">
# DateTime
根据ISO8601.定义一个日期和时间
类型 : 字符串 (日期-时间)
<a name="taxtype">
# TaxType
适用的税收类型.
类型 : 枚举
Value | Description |
---|---|
CGST | 中央商品和服务税(CGST)是由印度政府对货物和服务的境内流动征收的. |
SGST | 邦商品和服务税(SGST)是由印度的邦政府对邦内供应征收的间接税. |
CESS | A CESS是政府对具有特定目的的税收征收的一种形式,直到政府获得足够的资金用于该目的. |
UTGST | 印度联邦地区商品和服务税. |
IGST | 综合商品和服务税(IGST)是对印度所有邦际商品和/或服务供应征收的一种税. |
MwSt. | Mehrwertsteuer,MwSt,是德语中的增值税. |
PST | A省销售税(PST)是在加拿大许多省份对商品和特殊服务的消费者征收的. |
TVA | Taxe sur la Valeur Ajoutée (TVA)是法语中的增值税-Addition. |
VAT | Value-added tax. |
*GST | 对大多数为国内消费而销售的商品和服务所征收的税款. |
ST | Sales tax. |
消费 | 对商品和服务的消费支出征收的税收. |
MutuallyDefined | 亚马逊和供应商之间共同商定的税收部分. |
DomesticVAT | Domestic value-added tax. |
<a name="unitofmeasure">
# UnitOfMeasure
数量的计量单位.
类型 : 枚举
Value | Description |
---|---|
箱 | 将单个物品包装成一个箱子. |
Eaches | Individual items. |
<a name="税务登记类型">
# TaxRegistrationType
该实体的税务登记类型.
类型 : 枚举
Value | Description |
---|---|
VAT | Value-added tax. |
GST | 商品和服务税. |
<a name="invoicetype">
# InvoiceType
识别发票的类型.
类型 : 枚举
Value | Description |
---|---|
发票 | 由卖方发给买方的商业文件,与销售交易有关,表明卖方向买方提供的产品或服务的产品、数量和商定的价格. |
CreditNote | 卖方发给买方的商业文件.它是减少销售的证据. |
<a name="type">
# Type
类型 : 枚举
<a id="type-subgroup-1">用于定义(s)PaymentTerms 发票的付款条件类型.
Value | Description |
---|---|
基本 | 买方和卖方同意的付款期限. |
EndOfMonth | 支付条款,卖方在月底获得付款. |
固定日期 | 支付条款,卖方在与买方商定的固定日期获得付款. |
Proximo | 付款期限,卖方在下个月的月底获得付款. |
PaymentDueUponReceiptOfInvoice | 付款条款,卖方在收到买方的发票后获得付款. |
信用证 | 银行给卖方的付款承诺,代表申请人即.e.买方. |
<a id="type-subgroup-2">用于定义(s)AdditionalDetails 卖方提供的附加信息的类型.
Value | Description |
---|---|
SUR | 对已经征税的东西征收附加税,例如对超过一定水平的收入征收更高的税率. |
OCR | OCR. |
CartonCount | 开具发票的纸箱总数. |
<a id="type-subgroup-3">用于定义(s)AllowanceDetails 适用的津贴类型.
Value | Description |
---|---|
Discount | Discount allowance. |
DiscountIncentive | Discount incentive allowance. |
缺陷 | 对缺陷物品适用的津贴. |
Promotional | Promotional allowance. |
无法销售的商品 | 由于无法销售的商品而申请的津贴. |
Special | Special allowances. |
<a id="type-subgroup-4">用于定义(s)ChargeDetails 适用的收费类型.
Value | Description |
---|---|
Freight | Freight charges. |
Packing | Packing fee. |
Duty | Duty charges. |
Service | Service fee. |
小订单 | 小订单费用. |
InsurancePlacementCost | Insurance placement cost. |
InsuranceFee | Insurance fee. |
特别处理服务 | 特别处理服务费. |
收集和回收服务 | 收集和回收服务费. |
EnvironmentalProtectionService | Environmental protection service fee. |
源头收税 | 源头收税. |