Datum: 2008-03-14 Sida 1 av 19 Revisionshistorik Senaste ändringen först. version 5.0 Datum Version Kommentar 2008-03-14 5.0 Nya response-värden returneras vid sökning av faktura, pallsaldo och debiteringsbesked. Gäller punkt 3.2, 4.2 och 5.2. 2007-07-09 4.0 Länkar och exempelanrop uppdaterade. 2007-04-20 3.00 2005-08-30 2.0 2003-03-06 1.0 Uppdaterad med ny funktionalitet för visning och utsökning av pallsaldo. Punkt 5 och punkt 8 Uppdaterat dokumentationen med tillägg av nya obligatoriska variabler vid utsökning av debiteringsbesked. Detta är första gången denna dokumentation skrivs varför någon tidigare revisionshistorik ej finns.
Datum: 2008-03-14 Sida 2 av 19 INNEHÅLLSFÖRTECKNING REVISIONSHISTORIK... 1 1 GRÄNSSNITT FAKTURA/SALDOBESKED... 3 2 GENERELLA VARIABLER... 4 2.1 Request... 4 2.2 Response... 4 2.3 System... 4 3 MEDDELANDESÖKNING AV FAKTURA... 6 3.1 Request... 6 3.2 Responses... 8 4 MEDDELANDESÖKNING AV DEBITERINGSBESKED... 10 4.1 Request... 10 4.2 Response... 11 5 MEDDELANDESÖKNING AV PALLSALDOBESKED... 13 5.1 Request... 13 5.2 Response... 14 6 MEDDELANDEHÄMTNING AV PDF-FAKTURA... 16 6.1 Request... 16 6.2 Response... 17 7 MEDDELANDEHÄMTNING AV PDF-DEBITERINGSBESKED... 17 7.1 Request... 17 7.2 Response... 18 8 MEDDELANDEHÄMTNING AV PDF-PALLSALDOBESKED... 19 8.1 Request... 19 8.2 Response... 19
Datum: 2008-03-14 Sida 3 av 19 1 Gränssnitt Gränssnittet stöder sex olika metoder: Sökning av faktura, sökning av debiteringsbesked, sökning av pallsaldo, hämtning av faktura i pdf format, hämtning av debiteringsbesked i pdf format och hämtning av pallsaldo i pdf format. De generella variablerna är till för att administrera kommunikationen och är gemensamma för all kommunikation. De generella variablerna är: request, response samt system och beskrivs under rubriken generella variabler Variablerna data_list är en vektor av information med själva meddelandet som är specifikt per metod. Dessa beskrivs under rubrikerna för respektive metod. Rubriken O i tabellerna står för obligatoriskt fält. Tjänsten hittas på URL: http://was.webtrp.com/invoice_docweb/webaron?
Datum: 2008-03-14 Sida 4 av 19 2 Generella variabler 2.1 Request Innehåller information till tjänsten. Lägg till prefixet request. till variablerna. service.action O String WDR Värde select service.method O String WDR Värde search_invoice, search_debit, search_pallet_balance, pdf_invoice, pdf_debit och pdf_pallet_balance user.password O String WDR Användarens lösen user.login_name O String WDR Användarnamn Admin.e_mail String WDR Användarens epost-adress format.mime O String WDR Värde text/xml och text/plain önskat returformat 2.2 Response Innehåller information från tjänsten. Lägg till prefixet response. till variablerna. service.name O String WDR Namn på tjänsten service.version O String WDR Versionsnummer (1.0) data_list_count O Int WDR Antal i data_list 2.3 System Error variablerna innehåller felkod från systemet och returneras med response variablerna. Statistics variablerna innehåller statistikvariabler till systemet och skickas tillsammans med request variablerna. Lägg till prefixet system. till variablerna. error.id O Int WDR Felkod error.id = 0 betyder OK error.message String WDR Felmeddelande statistics.remote.country_code O String WDR Landskod för klient, ex. se eller us
Datum: 2008-03-14 Sida 5 av 19 statistics.remote.send_data_format O String WDR Klientens sätt att skicka sin Request, xml eller hqf (Http Query at) statistics.remote.access_type O String WDR Klientens anropstyp, A (webbläsare) statistics.remote.application_name O String WDR Klientens sida/modul som anropar statistics.user.return_mime_format O String WDR Klientens önskade svarsformat, text/plain, text/html eller text/xml statistics.user.organization_id O String WDR Klientens momsregistreringsnummer statistics.user.language_code O String WDR Språkkod för klient, ex. sv_se
Datum: 2008-03-14 Sida 6 av 19 3 Meddelandesökning av faktura service.method = search_invoice Faktura kan sökas på tre olika sätt: fakturanummer (reference_type=iv) sändningsnummer (reference_type=sm) datumintervall (reference_type=date). Om reference_type = iv eller sm används variabeln reference_number för att ange fakturanummer eller sändningsnummer. Om reference_type = date används variablerna start_date och end_date för att ange periodens start och slutdatum. 3.1 Request Information som skickas till tjänsten tillsammans med request variablerna. Lägg till prefixet data_list.0. till variablerna. reference_type O String RFF Värde iv, sm och date iv = Fakturanummer (commercial_invoice_number) sm = Sändningsnummer (shipment_reference_number) date = Datumintervall reference_number O String RFF See Reference type Obligatorisk om reference_type = iv,eller sm start_date O String DTM 2005-194 end_date O String DTM 2005-206 Periodens startdatum Obligatorisk om reference_type = date = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Periodens slutdatum Obligatorisk om reference_type = date = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Exempel på sökning efter faktura via fakturanummer.
Datum: 2008-03-14 Sida 7 av 19 <Fakturanummer> enord>&request.admin.e_mail=<e_postadress>&request.service.action=select&request.service.m ethod=search_invoice&data_list.0.reference_type=iv&data_list.0.reference_number=<fakturanu mmer> Exempel på sökning efter faktura via sändningsnummer. <Sändningsnummer> enord>&request.admin.e_mail=<e_postadress>&request.service.action=select&request.service.m ethod=search_invoice&data_list.0.reference_type=sm&data_list.0.reference_number=<sändning snummer> Exempel på sökning efter faktura vid datumintervall. <Kundnummer>
Datum: 2008-03-14 Sida 8 av 19 enord>&request.admin.e_mail=<e_postadress>&request.service.action=select&request.service.m ethod=search_invoice&data_list.0.reference_type=date&data_list.0.start_date=2007-06- 23&data_list.0.end_date=2007-06-30&data_list.0.customer_number=<Kundnummer> 3.2 Responses Information som returneras från tjänsten tillsammans med response variablerna. Lägg till prefixet data_list.n. till variablerna, där n är ett index som startar på 0. invoice_total_monetary_amount String MOA 5025-86 DE 5004 commercial_invoice_number String RFF 1153-IV DE 1154 invoice_date Date DTM 2005-2 customer_number String NAD DE 3039 office_number String NAD DE 3039 office_name String NAD DE 3036 Fakturabelopp Fakturanummer Datum när fakturan är utfärdad Kundnummer Kontorsnummer Kontorsnamn invoice_product_number String RFF Produktnummer 10=DKS 11=Adena Picko 13=DKS 16=DKS 30=Gods 32=Pall 33=Coldsped 34=Företagsbil 36=Parcel 39=Tankdata 40=Consulting 42=Logistics 900=Pallkreditering
Datum: 2008-03-14 Sida 9 av 19 Exempel på svar: <?xml version="1.0" encoding="iso-8859-1"?> - <xml> - <response> <data_list_count>1</data_list_count> - <service> <name>invoicedoc</name> <version>1.0</version> </service> </response> - <system> - <error> <message>your request was successfully processed.</message> <id>0</id> </error> </system> - <data_list> - <data index="0"> <commercial_invoice_number>111111111</commercial_invoice_number> <invoice_total_monetary_amount>800.00</invoice_total_monetary_amount> <office_number>356</office_number> <customer_number>12345678</customer_number> <office_name>linköping</office_name> <invoice_date>2007-03-23</invoice_date> <invoice_product_number>30</invoice_product_number> </data> </data_list> </xml>
Datum: 2008-03-14 Sida 10 av 19 4 Meddelandesökning av debiteringsbesked service.method = search_debit Debiteringsbesked kan sökas på två sätt: datumintervall (reference_type=date) fakturanummer (reference_type=iv). Om reference_type = iv används variabeln reference_number för att ange fakturanummer. Om reference_type = date används variablerna start_date och end_date för att ange periodens start och slutdatum. 4.1 Request Information som skickas till tjänsten tillsammans med request variablerna. Lägg till prefixet data_list.0. till variablerna. reference_type O String RFF Värde iv och date iv = Fakturanummer (commercial_invoice_number) date = Datumintervall reference_number O String RFF See Reference type Obligatorisk om reference_type = iv start_date O String DTM 2005-194 end_date O String DTM 2005-206 Periodens startdatum = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Periodens slutdatum = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Exempel på sökning efter debiteringsbesked via datumintervall.
Datum: 2008-03-14 Sida 11 av 19 <Kundnummer> enord>&request.admin.e_mail=<e_postadress>&request.service.action=select&request.service.m ethod=search_debit&data_list.0.reference_type=date&data_list.0.start_date=2007-06- 23&data_list.0.end_date=2007-06-30&data_list.0.customer_number=<Kundnummer> Exempel på sökning efter debiteringsbesked via fakturanummer. <Fakturanummer> enord>&request.admin.e_mail=<e_postadress>&request.service.action=select&request.service.m ethod=search_debit&data_list.0.reference_type=iv&data_list.0.reference_number=<fakturanumm er> 4.2 Response Information som returneras från tjänsten tillsammans med response variablerna. Lägg till prefixet data_list.n. till variablerna, där n är ett index som startar på 0. customer_number String NAD DE 3039 office_number String NAD DE 3039 office_name String NAD DE 3036 commercial_invoice_number String RFF 1153-IV DE 1154 Kundnummer Kontorsnummer Kontorsnamn Fakturanummer
Datum: 2008-03-14 Sida 12 av 19 accounting_period_start_date O String DTM 2005-155 charge_amount String TCC 5025-23 DE 5004 debet_date Date DTM 2005-137 debit_id String Konteringsperiodens startdatum = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Debiteringssumma Datum när debiteringsbeskedet är utfärdat. Exempel på svar: <?xml version="1.0" encoding="iso-8859-1"?> - <xml> - <system> - <error> <id>0</id> <message>your request was successfully processed.</message> </error> </system> - <response> <data_list_count>2</data_list_count> - <service> <version>1.0</version> <name>invoicedoc</name> </service> </response> - <data_list> - <data index="1"> <charge_amount>883</charge_amount> <office_name>örebro</office_name> <debit_date>070322</debit_date> <office_number>422</office_number> <debit_id>428447</debit_id> <commercial_invoice_number>111111111</commercial_invoice_number> <customer_number>12345678</customer_number> <accounting_period_start_date>070323</accounting_period_start_date> </data> - <data index="0"> <charge_amount>495</charge_amount> <debit_id>427103</debit_id> <debit_date>070320</debit_date> <office_number>422</office_number> <accounting_period_start_date>070323</accounting_period_start_date> <customer_number>12345678</customer_number> <commercial_invoice_number>111111111</commercial_invoice_number> <office_name>örebro</office_name> </data> </data_list> </xml>
Datum: 2008-03-14 Sida 13 av 19 5 Meddelandesökning av pallsaldobesked service.method = search_pallet_balance Pallsaldobesked kan sökas på två sätt: datumintervall (reference_type=date) fakturanummer (reference_type=iv). Om reference_type = iv används variabeln reference_number för att ange fakturanummer. Om reference_type = date används variablerna start_date och end_date för att ange periodens start och slutdatum. 5.1 Request Information som skickas till tjänsten tillsammans med request variablerna. Lägg till prefixet data_list.0. till variablerna. reference_type O String RFF Värde iv och date iv = Fakturanummer (commercial_invoice_number) date = Datumintervall reference_number O String RFF See Reference type Obligatorisk om reference_type = iv start_date O String DTM 2005-194 end_date O String DTM 2005-206 Periodens startdatums = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Periodens slutdatum = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Exempel på sökning efter pallsaldobesked via datumintervall. <Kundnummer>
Datum: 2008-03-14 Sida 14 av 19 enord>&request.admin.e_mail=<e_postadress>&request.service.action=select&request.service.m ethod=search_pallet_balance&data_list.0.reference_type=date&data_list.0.start_date=2007-06- 23&data_list.0.end_date=2007-06-30&data_list.0.customer_number=<Kundnummer> Exempel på sökning efter pallsaldobesked via fakturanummer. <Fakturanummer> enord>&request.admin.e_mail=<e_postadress>&request.service.action=select&request.service.m ethod=search_pallet_balance&data_list.0.reference_type=iv&data_list.0.reference_number=<fakt uranummer> 5.2 Response Information som returneras från tjänsten tillsammans med response variablerna. Lägg till prefixet data_list.n. till variablerna, där n är ett index som startar på 0. customer_number String NAD DE 3039 office_name String NAD DE 3036 commercial_invoice_number String RFF 1153-IV DE 1154 pallet_balance_date String DTM 2005-137 Kundnummer Kontorsnummer Fakturanummer Datum när pallsaldobeskedet är utfärdat.
Datum: 2008-03-14 Sida 15 av 19 pallet_balance_identification String FTX Pallsaldonummer pallet_balance_count CMT Saldo (Antal pallar) Exempel på svar: <?xml version="1.0" encoding="iso-8859-1"?> - <xml> - <response> <data_list_count>2</data_list_count> - <service> <name>invoicedoc</name> <version>1.0</version> </service> </response> - <system> - <error> <message>your request was successfully processed.</message> <id>0</id> </error> </system> - <data_list> - <data index="1"> <pallet_balance>oss tillgodo 264</pallet_balance> <commercial_invoice_number>123456789</commercial_invoice_number> <office_name>stockholm</office_name> <pallet_balance_date>2007-03-31</pallet_balance_date> <customer_number>12345678</customer_number> <pallet_balance_identification>1234567</pallet_balance_identification> </data> - <data index="0"> <commercial_invoice_number>123456789</commercial_invoice_number> <pallet_balance_date>2007-03-15</pallet_balance_date> <pallet_balance>oss tillgodo 210</pallet_balance> <customer_number>12345678</customer_number> <office_name>stockholm</office_name> <pallet_balance_identification>1234567</pallet_balance_identification> </data> </data_list> </xml>
Datum: 2008-03-14 Sida 16 av 19 6 Meddelandehämtning av pdf-faktura service.method = pdf_invoice 6.1 Request Information som skickas till tjänsten tillsammans med request variablerna. Lägg till prefixet data_list.0. till variablerna. customer_number O String NAD DE 3039 commercial_invoice_number O String RFF 1153-IV DE 1154 invoice_date O String DTM 2005-2 Kundnummer Fakturanummer Datum när fakturan är utfärdad Exempel på hämtning av pdf-faktura. <Fakturanummer> <Kundnummer> enord>&request.service.method=pdf_invoice&request.service.action=select&request.admin.e_ma il=<e_postadress>&data_list.0.commercial_invoice_number=<fakturanummer>&data_list.0.invoic e_date=2007-06-23&data_list.0.customer_number=<kundnummer>
Datum: 2008-03-14 Sida 17 av 19 6.2 Response En pdf returneras om sökningen ger träff. I annat fall returneras de generella variablerna. 7 Meddelandehämtning av pdf-debiteringsbesked service.method = pdf_debit 7.1 Request Information som skickas till tjänsten tillsammans med request variablerna. Lägg till prefixet data_list.0. till variablerna. customer_number O String NAD DE 3039 office_name O String NAD DE 3036 accounting_period_start_date O String DTM 2005-155 debit_date O Date DTM 2005-137 invoice_total_monetary_amount O String MOA 5025-86 DE 5004 Kundnummer Kontorsnamn Konteringsperiodens startdatum = Date/time/period format code, code 4 = CCYYMMDD, example: 20080731 Datum när debiteringsbeskedet är utfärdat. Saldobelopp Exempel på hämtning av pdf-debiteringsbesked. <Kundnummer>
Datum: 2008-03-14 Sida 18 av 19 enord>&request.service.method=pdf_debit&request.service.action=select&request.admin.e_mail= <e_postadress>&data_list.0.debit_date=2007-06- 23&data_list.0.accounting_period_start_date=2007-06- 23&data_list.0.office_name=NYBRO&data_list.0.invoice_total_monetary_amount=12.816&data_li st.0.customer_number=<kundnummer> 7.2 Response En pdf returneras om sökningen ger träff. I annat fall returneras de generella variablerna.
Datum: 2008-03-14 Sida 19 av 19 8 Meddelandehämtning av pdf-pallsaldobesked service.method = pdf_pallet_balance 8.1 Request Information som skickas till tjänsten tillsammans med request variablerna. Lägg till prefixet data_list.0. till variablerna. customer_number String NAD DE 3039 pallet_balance_date String DTM 2005-137 Kundnummer Datum när pallsaldobeskedet är utfärdat. pallet_balance_identification String FTX Pallsaldonummer Exempel på hämtning av pdf-pallsaldobesked. <Pallsaldonummer> <Kundnummer> enord>&request.service.method=pdf_pallet_balance&request.service.action=select&request.admi n.e_mail=<e_postadress>&data_list.0.pallet_balance_identification=<pallsaldonummer>&data_lis t.0.pallet_balance_date=2007-03-31&data_list.0.customer_number=<kundnummer> 8.2 Response En pdf returneras om sökningen ger träff. I annat fall returneras de generella variablerna.