# 概述
用于直接履行付款的销售伙伴API提供了对直接履行供应商的发票数据的程序化访问.
# Version information
版本 : v1
# Operations
submitInvoice
<a name="paths">
# 路径
<a name="submitinvoice">
# submitInvoice
POST /vendor/directFulfillment/payments/v1/invoices
# Description
为一个供应商的直接履行订单提交一张或多张发票.
使用计划:
计划类型 | 速率(每秒的请求) | 突发 |
---|---|---|
Default | 10 | 10 |
销售伙伴具体 | 变量 | 变量 |
x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | submitInvoice操作的请求模式. | SubmitInvoiceRequest |
# Responses
HTTP Code | Description | Schema |
---|---|---|
202 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
错误状态代码、描述和模式,见错误响应和模式.
<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. | SubmitInvoiceResponse |
403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. **头信息 x-amzn-RequestId (string):Unique request reference identifier. | SubmitInvoiceResponse |
404 | 指定的资源不存在. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | SubmitInvoiceResponse |
413 | 请求的大小超过了最大接受的大小. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoiceResponse |
415 | 请求的有效载荷是不支持的格式. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoiceResponse |
429 | 请求的频率超过了允许的范围. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoiceResponse |
500 | 发生了一个意外情况,使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | SubmitInvoiceResponse |
503 | 服务器临时超载或维护. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作._注意 _对于这个状态码,速率限制头已经过时,不再返回. x-amzn-RequestId (string):唯一的请求参考标识. | SubmitInvoiceResponse |
<a name="definitions">
# Definitions
<a name="submitinvoicerequest">
# SubmitInvoiceRequest
提交发票操作的请求模式.
Name | Schema |
---|---|
invoices optional | < InvoiceDetail > array |
<a name=" invoicedetail">
# InvoiceDetail
Name | Description | Schema |
---|---|---|
invoiceNumber required | 唯一的发票号码. | string |
invoiceDate required | Invoice date. | string (date-time) |
参考号码 可选的 | 一个额外的唯一参考号码,用于监管或其他目的. | 字符串 |
remitToParty required | 接收此发票付款的一方的名称、地址和税务细节. | PartyIdentification |
billToParty optional | 被开具此发票的一方的姓名、地址和纳税细节. | PartyIdentification |
shipToCountryCode optional | Ship-to country code. | string |
支付条款代码 可选择 | 发票的支付条款. | string |
invoiceTotal required | 发票的总金额详情. | Money |
taxTotals optional | 每行的个人税收细节. | < TaxDetail> array |
additionalDetails optional | 由销售方提供的额外细节,用于税务相关或其他目的. | < AdditionalDetails > array |
chargeDetails optional | 所有行项目的总收费金额详情. | < ChargeDetails > array |
items required | 提供这张发票中物品的详细信息. | < InvoiceItem > array |
<a name="invoiceitem">
# InvoiceItem
Name | Description | Schema |
---|---|---|
itemSequenceNumber required | Numbering of the item on the purchase order. 第一个项目将是1,第二个是2,以此类推. | string |
buyerProductIdentifier optional | Buyer's standard identification number (ASIN) of a item. | string |
vendorProductIdentifier optional | 供应商选定的物品的产品标识. | string |
invoicedQuantity required | Item quantity invoiced. | ItemQuantity |
netCost required | Net price (before tax) to vendor with currency details. | Money |
采购订单号 必填 | 此订单的采购订单号.格式说明8-character alpha-numeric code. | string |
vendorOrderNumber optional | 本订单的供应商订单号. | string |
hsnCode optional | HSN税号.HSN号码不能包含字母. | string |
taxDetails optional | 每一行的个人税收细节. | < TaxDetail> array |
chargeDetails optional | 每一行的个别收费细节. | < ChargeDetails> array |
<a name="partyidentification">
# PartyIdentification
Name | Description | Schema |
---|---|---|
partyId required | 为当事人分配的标识. | string |
地址 可选的 | 按地址确定的当事人身份. | 地址 |
税务登记细节 可选 | 实体的税务登记细节. | < TaxRegistrationDetail >数组 |
<a name="taxregistrationdetail">
# TaxRegistrationDetail
实体的税务登记详情.
Name | Description | Schema |
---|---|---|
税率注册类型 可选 | 实体的税率注册类型. | enum (税率注册类型) |
taxRegistrationNumber required | 当事人的税务登记号码.例如,VAT ID. | string |
税务登记地址 可选的 | 与税务登记号码相关的地址. | 地址 |
税务登记信息 可选的 | 税务登记信息,可用于额外的税务相关细节. | string |
<a name="地址">
# Address
当事人的地址.
Name | Description | Schema |
---|---|---|
name required | 该地址的个人、企业或机构的名称. | string |
addressLine1 required | 地址的第一行. | string |
addressLine2 optional | 额外的街道地址信息,如果需要的话. | string |
addressLine3 optional | Additional street address information, if required. | string |
city required | 个人、企业或机构所在的城市. | string |
县 可选择 | 个人、企业或机构所在的县. | string |
区 可选择 | 个人、企业或机构所在的区. | string |
stateOrRegion required | 个人、企业或机构所在的州或地区. | string |
postalCode required | 该地址的邮政编码.它由一系列的字母或数字或两者组成,有时包括空格或标点符号. | string |
countryCode required | ISO 3166-1 alpha-2格式的两个数字的国家代码. | string |
电话 可选 | 位于该地址的个人、企业或机构的电话号码. | string |
<a name="money">
# Money
钱的数量,包括货币形式的单位.
Name | Description | Schema |
---|---|---|
currencyCode required | 三位数的ISO 4217格式的货币代码. | string |
amount required | 一个没有精度损失的十进制数字.当精度损失是不可接受的时候很有用,比如货币.遵循RFC7159的数字表示法. Pattern : ^-?(0\|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$ . | Decimal |
<a name="decimal">
# Decimal
一个没有精度损失的十进制数.当精度损失不可接受时,非常有用,比如货币.遵循RFC7159的数字表示法.
模式^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$
.
类型:字符串
<a name="taxdetail">
# TaxDetail
适用的税额详情.
Name | Description | Schema |
---|---|---|
taxType required | Type of the tax applied. | enum (TaxType |
税率 可选 | 适用的税收百分比.百分比必须以十进制表示. | Decimal |
taxAmount required | 应用于发票总额或项目总额的总税额. | Money |
taxableAmount optional | 这个字段将包含在税率字段中指定的应纳税额. | Money |
<a name="chargeetails">
# ChargeDetails
收费的货币和税收细节.
Name | Description | Schema |
---|---|---|
类型 要求 | 应用的收费类型. | enum (类型) |
chargeAmount required | 一个金额,包括货币形式的单位. | Money |
taxDetails optional | 每一行的个别税项细节. | < TaxDetail >数组 |
<a name="additionaldetails">
# AdditionalDetails
一个字段,销售方可以提供额外的信息,用于税务相关或任何其他目的.
Name | Description | Schema |
---|---|---|
类型 要求 | 销售方提供的附加信息的类型. | enum (Type) |
detail required | 由销售方提供的附加信息的细节. | string |
languageCode optional | 附加信息细节的语言代码. | string |
<a name="itemquantity">
# ItemQuantity
项目数量的详细信息.
Name | Description | Schema |
---|---|---|
数额 要求 | 特定项目的可用单位数量. | 整数 |
unitOfMeasure required | 可用数量的计量单位. | string |
<a name="submitinvoiceresponse">
# SubmitInvoiceResponse
提交发票操作的响应模式.
Name | Description | Schema |
---|---|---|
payload optional | submitInvoice操作的响应有效载荷. | TransactionReference |
errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
<a name="transactionreference">
# TransactionReference
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="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="taxregistrationtype">
# TaxRegistrationType
该实体的税务登记类型.
类型 : 枚举
Value | Description |
---|---|
VAT | Value-added tax. |
GST | 商品和服务税. |
<a name="type">
# Type
类型 : 枚举
<a id="type-subgroup-1">用于定义(s)AdditionalDetails 卖方提供的附加信息的类型.
Value | Description |
---|---|
SUR | 对已经征税的东西征收附加税,例如对超过一定水平的收入征收更高的税率. |
OCR | OCR. |
<a id="type-subgroup-2">用于定义(s)ChargeDetails 适用的收费类型.
Value | Description |
---|---|
GIFTWRAP | 对礼品包装订单收取额外费用. |
FULFILLMENT | Fulfillment费用是指接收和储存产品以及处理订单从处理到运输的相关费用. |
MARKETINGINSERT | 在订单上插入广告的费用. |
包装 | 包装订单的附加费用. |
LOADING | 装载订单的额外费用. |
FREIGHTOUT | Freight-out是指卖方在运送给买方时负责的费用,如送货和保险费用. |
TAX_COLLECTED_AT_SOURCE | Tax collected at source (TCS)是指卖方在销售时向买方收取的应付税款. |